dbnodes

package
v0.20240903.1131440 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/dbnodes Documentation

The dbnodes SDK allows for interaction with the Azure Resource Manager Service oracledatabase (API Version 2024-06-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/dbnodes"

Client Initialization

client := dbnodes.NewDbNodesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DbNodesClient.Action

ctx := context.TODO()
id := dbnodes.NewDbNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "cloudVmClusterValue", "dbNodeValue")

payload := dbnodes.DbNodeAction{
	// ...
}


if err := client.ActionThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DbNodesClient.Get

ctx := context.TODO()
id := dbnodes.NewDbNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "cloudVmClusterValue", "dbNodeValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DbNodesClient.ListByCloudVMCluster

ctx := context.TODO()
id := dbnodes.NewCloudVMClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "cloudVmClusterValue")

// alternatively `client.ListByCloudVMCluster(ctx, id)` can be used to do batched pagination
items, err := client.ListByCloudVMClusterComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDbNodeActionEnum 

func PossibleValuesForDbNodeActionEnum() []string

func PossibleValuesForDbNodeMaintenanceType 

func PossibleValuesForDbNodeMaintenanceType() []string

func PossibleValuesForDbNodeProvisioningState 

func PossibleValuesForDbNodeProvisioningState() []string

func PossibleValuesForResourceProvisioningState 

func PossibleValuesForResourceProvisioningState() []string

func ValidateCloudVMClusterID 

func ValidateCloudVMClusterID(input interface{}, key string) (warnings []string, errors []error)

ValidateCloudVMClusterID checks that 'input' can be parsed as a Cloud V M Cluster ID

func ValidateDbNodeID 

func ValidateDbNodeID(input interface{}, key string) (warnings []string, errors []error)

ValidateDbNodeID checks that 'input' can be parsed as a Db Node ID

Types

type ActionOperationResponse 

type ActionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DbNode
}

type CloudVMClusterId 

type CloudVMClusterId struct {
	SubscriptionId     string
	ResourceGroupName  string
	CloudVmClusterName string
}

CloudVMClusterId is a struct representing the Resource ID for a Cloud V M Cluster

func NewCloudVMClusterID 

func NewCloudVMClusterID(subscriptionId string, resourceGroupName string, cloudVmClusterName string) CloudVMClusterId

NewCloudVMClusterID returns a new CloudVMClusterId struct

func ParseCloudVMClusterID 

func ParseCloudVMClusterID(input string) (*CloudVMClusterId, error)

ParseCloudVMClusterID parses 'input' into a CloudVMClusterId

func ParseCloudVMClusterIDInsensitively 

func ParseCloudVMClusterIDInsensitively(input string) (*CloudVMClusterId, error)

ParseCloudVMClusterIDInsensitively parses 'input' case-insensitively into a CloudVMClusterId note: this method should only be used for API response data and not user input

func (*CloudVMClusterId) FromParseResult 

func (id *CloudVMClusterId) FromParseResult(input resourceids.ParseResult) error

func (CloudVMClusterId) ID 

func (id CloudVMClusterId) ID() string

ID returns the formatted Cloud V M Cluster ID

func (CloudVMClusterId) Segments 

func (id CloudVMClusterId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Cloud V M Cluster ID

func (CloudVMClusterId) String 

func (id CloudVMClusterId) String() string

String returns a human-readable description of this Cloud V M Cluster ID

type DbNode 

type DbNode struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *DbNodeProperties      `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type DbNodeAction 

type DbNodeAction struct {
	Action DbNodeActionEnum `json:"action"`
}

type DbNodeActionEnum 

type DbNodeActionEnum string
const (
	DbNodeActionEnumReset     DbNodeActionEnum = "Reset"
	DbNodeActionEnumSoftReset DbNodeActionEnum = "SoftReset"
	DbNodeActionEnumStart     DbNodeActionEnum = "Start"
	DbNodeActionEnumStop      DbNodeActionEnum = "Stop"
)

func (*DbNodeActionEnum) UnmarshalJSON 

func (s *DbNodeActionEnum) UnmarshalJSON(bytes []byte) error

type DbNodeId 

type DbNodeId struct {
	SubscriptionId     string
	ResourceGroupName  string
	CloudVmClusterName string
	DbNodeName         string
}

DbNodeId is a struct representing the Resource ID for a Db Node

func NewDbNodeID 

func NewDbNodeID(subscriptionId string, resourceGroupName string, cloudVmClusterName string, dbNodeName string) DbNodeId

NewDbNodeID returns a new DbNodeId struct

func ParseDbNodeID 

func ParseDbNodeID(input string) (*DbNodeId, error)

ParseDbNodeID parses 'input' into a DbNodeId

func ParseDbNodeIDInsensitively 

func ParseDbNodeIDInsensitively(input string) (*DbNodeId, error)

ParseDbNodeIDInsensitively parses 'input' case-insensitively into a DbNodeId note: this method should only be used for API response data and not user input

func (*DbNodeId) FromParseResult 

func (id *DbNodeId) FromParseResult(input resourceids.ParseResult) error

func (DbNodeId) ID 

func (id DbNodeId) ID() string

ID returns the formatted Db Node ID

func (DbNodeId) Segments 

func (id DbNodeId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Db Node ID

func (DbNodeId) String 

func (id DbNodeId) String() string

String returns a human-readable description of this Db Node ID

type DbNodeMaintenanceType 

type DbNodeMaintenanceType string
const (
	DbNodeMaintenanceTypeVMdbRebootMigration DbNodeMaintenanceType = "VmdbRebootMigration"
)

func (*DbNodeMaintenanceType) UnmarshalJSON 

func (s *DbNodeMaintenanceType) UnmarshalJSON(bytes []byte) error

type DbNodeOperationPredicate 

type DbNodeOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DbNodeOperationPredicate) Matches 

func (p DbNodeOperationPredicate) Matches(input DbNode) bool

type DbNodeProperties 

type DbNodeProperties struct {
	AdditionalDetails          *string                    `json:"additionalDetails,omitempty"`
	BackupIPId                 *string                    `json:"backupIpId,omitempty"`
	BackupVnic2Id              *string                    `json:"backupVnic2Id,omitempty"`
	BackupVnicId               *string                    `json:"backupVnicId,omitempty"`
	CpuCoreCount               *int64                     `json:"cpuCoreCount,omitempty"`
	DbNodeStorageSizeInGbs     *int64                     `json:"dbNodeStorageSizeInGbs,omitempty"`
	DbServerId                 *string                    `json:"dbServerId,omitempty"`
	DbSystemId                 *string                    `json:"dbSystemId,omitempty"`
	FaultDomain                *string                    `json:"faultDomain,omitempty"`
	HostIPId                   *string                    `json:"hostIpId,omitempty"`
	Hostname                   *string                    `json:"hostname,omitempty"`
	LifecycleDetails           *string                    `json:"lifecycleDetails,omitempty"`
	LifecycleState             *DbNodeProvisioningState   `json:"lifecycleState,omitempty"`
	MaintenanceType            *DbNodeMaintenanceType     `json:"maintenanceType,omitempty"`
	MemorySizeInGbs            *int64                     `json:"memorySizeInGbs,omitempty"`
	Ocid                       *string                    `json:"ocid,omitempty"`
	ProvisioningState          *ResourceProvisioningState `json:"provisioningState,omitempty"`
	SoftwareStorageSizeInGb    *int64                     `json:"softwareStorageSizeInGb,omitempty"`
	TimeCreated                *string                    `json:"timeCreated,omitempty"`
	TimeMaintenanceWindowEnd   *string                    `json:"timeMaintenanceWindowEnd,omitempty"`
	TimeMaintenanceWindowStart *string                    `json:"timeMaintenanceWindowStart,omitempty"`
	Vnic2Id                    *string                    `json:"vnic2Id,omitempty"`
	VnicId                     *string                    `json:"vnicId,omitempty"`
}

func (*DbNodeProperties) GetTimeCreatedAsTime 

func (o *DbNodeProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*DbNodeProperties) GetTimeMaintenanceWindowEndAsTime 

func (o *DbNodeProperties) GetTimeMaintenanceWindowEndAsTime() (*time.Time, error)

func (*DbNodeProperties) GetTimeMaintenanceWindowStartAsTime 

func (o *DbNodeProperties) GetTimeMaintenanceWindowStartAsTime() (*time.Time, error)

func (*DbNodeProperties) SetTimeCreatedAsTime 

func (o *DbNodeProperties) SetTimeCreatedAsTime(input time.Time)

func (*DbNodeProperties) SetTimeMaintenanceWindowEndAsTime 

func (o *DbNodeProperties) SetTimeMaintenanceWindowEndAsTime(input time.Time)

func (*DbNodeProperties) SetTimeMaintenanceWindowStartAsTime 

func (o *DbNodeProperties) SetTimeMaintenanceWindowStartAsTime(input time.Time)

type DbNodeProvisioningState 

type DbNodeProvisioningState string
const (
	DbNodeProvisioningStateAvailable    DbNodeProvisioningState = "Available"
	DbNodeProvisioningStateFailed       DbNodeProvisioningState = "Failed"
	DbNodeProvisioningStateProvisioning DbNodeProvisioningState = "Provisioning"
	DbNodeProvisioningStateStarting     DbNodeProvisioningState = "Starting"
	DbNodeProvisioningStateStopped      DbNodeProvisioningState = "Stopped"
	DbNodeProvisioningStateStopping     DbNodeProvisioningState = "Stopping"
	DbNodeProvisioningStateTerminated   DbNodeProvisioningState = "Terminated"
	DbNodeProvisioningStateTerminating  DbNodeProvisioningState = "Terminating"
	DbNodeProvisioningStateUpdating     DbNodeProvisioningState = "Updating"
)

func (*DbNodeProvisioningState) UnmarshalJSON 

func (s *DbNodeProvisioningState) UnmarshalJSON(bytes []byte) error

type DbNodesClient 

type DbNodesClient struct {
	Client *resourcemanager.Client
}

func NewDbNodesClientWithBaseURI 

func NewDbNodesClientWithBaseURI(sdkApi sdkEnv.Api) (*DbNodesClient, error)

func (DbNodesClient) Action 

func (c DbNodesClient) Action(ctx context.Context, id DbNodeId, input DbNodeAction) (result ActionOperationResponse, err error)

Action ...

func (DbNodesClient) ActionThenPoll 

func (c DbNodesClient) ActionThenPoll(ctx context.Context, id DbNodeId, input DbNodeAction) error

ActionThenPoll performs Action then polls until it's completed

func (DbNodesClient) Get 

func (c DbNodesClient) Get(ctx context.Context, id DbNodeId) (result GetOperationResponse, err error)

Get ...

func (DbNodesClient) ListByCloudVMCluster 

func (c DbNodesClient) ListByCloudVMCluster(ctx context.Context, id CloudVMClusterId) (result ListByCloudVMClusterOperationResponse, err error)

ListByCloudVMCluster ...

func (DbNodesClient) ListByCloudVMClusterComplete 

func (c DbNodesClient) ListByCloudVMClusterComplete(ctx context.Context, id CloudVMClusterId) (ListByCloudVMClusterCompleteResult, error)

ListByCloudVMClusterComplete retrieves all the results into a single object

func (DbNodesClient) ListByCloudVMClusterCompleteMatchingPredicate 

func (c DbNodesClient) ListByCloudVMClusterCompleteMatchingPredicate(ctx context.Context, id CloudVMClusterId, predicate DbNodeOperationPredicate) (result ListByCloudVMClusterCompleteResult, err error)

ListByCloudVMClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DbNode
}

type ListByCloudVMClusterCompleteResult 

type ListByCloudVMClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DbNode
}

type ListByCloudVMClusterCustomPager 

type ListByCloudVMClusterCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByCloudVMClusterCustomPager) NextPageLink() *odata.Link

type ListByCloudVMClusterOperationResponse 

type ListByCloudVMClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DbNode
}

type ResourceProvisioningState 

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
)

func (*ResourceProvisioningState) UnmarshalJSON 

func (s *ResourceProvisioningState) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.