datatransfer

package
v0.20240603.1170338 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/cosmosdb/2023-11-15/datatransfer Documentation

The datatransfer SDK allows for interaction with the Azure Resource Manager Service cosmosdb (API Version 2023-11-15).

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/cosmosdb/2023-11-15/datatransfer"

Client Initialization

client := datatransfer.NewDataTransferClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataTransferClient.ServiceCreate

ctx := context.TODO()
id := datatransfer.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "databaseAccountValue", "serviceValue")

payload := datatransfer.ServiceResourceCreateUpdateParameters{
	// ...
}


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

Example Usage: DataTransferClient.ServiceDelete

ctx := context.TODO()
id := datatransfer.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "databaseAccountValue", "serviceValue")

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

Example Usage: DataTransferClient.ServiceGet

ctx := context.TODO()
id := datatransfer.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "databaseAccountValue", "serviceValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForServiceSize

func PossibleValuesForServiceSize() []string

func PossibleValuesForServiceStatus

func PossibleValuesForServiceStatus() []string

func PossibleValuesForServiceType

func PossibleValuesForServiceType() []string

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type DataTransferClient

type DataTransferClient struct {
	Client *resourcemanager.Client
}

func NewDataTransferClientWithBaseURI

func NewDataTransferClientWithBaseURI(sdkApi sdkEnv.Api) (*DataTransferClient, error)

func (DataTransferClient) ServiceCreate

ServiceCreate ...

func (DataTransferClient) ServiceCreateThenPoll

ServiceCreateThenPoll performs ServiceCreate then polls until it's completed

func (DataTransferClient) ServiceDelete

func (c DataTransferClient) ServiceDelete(ctx context.Context, id ServiceId) (result ServiceDeleteOperationResponse, err error)

ServiceDelete ...

func (DataTransferClient) ServiceDeleteThenPoll

func (c DataTransferClient) ServiceDeleteThenPoll(ctx context.Context, id ServiceId) error

ServiceDeleteThenPoll performs ServiceDelete then polls until it's completed

func (DataTransferClient) ServiceGet

func (c DataTransferClient) ServiceGet(ctx context.Context, id ServiceId) (result ServiceGetOperationResponse, err error)

ServiceGet ...

type DataTransferServiceResourceProperties

type DataTransferServiceResourceProperties struct {
	Locations *[]RegionalServiceResource `json:"locations,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*DataTransferServiceResourceProperties) GetCreationTimeAsTime

func (o *DataTransferServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (DataTransferServiceResourceProperties) MarshalJSON

func (s DataTransferServiceResourceProperties) MarshalJSON() ([]byte, error)

func (*DataTransferServiceResourceProperties) SetCreationTimeAsTime

func (o *DataTransferServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

type GraphAPIComputeRegionalServiceResource

type GraphAPIComputeRegionalServiceResource struct {
	GraphApiComputeEndpoint *string        `json:"graphApiComputeEndpoint,omitempty"`
	Location                *string        `json:"location,omitempty"`
	Name                    *string        `json:"name,omitempty"`
	Status                  *ServiceStatus `json:"status,omitempty"`
}

type GraphAPIComputeServiceResourceProperties

type GraphAPIComputeServiceResourceProperties struct {
	GraphApiComputeEndpoint *string                                   `json:"graphApiComputeEndpoint,omitempty"`
	Locations               *[]GraphAPIComputeRegionalServiceResource `json:"locations,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*GraphAPIComputeServiceResourceProperties) GetCreationTimeAsTime

func (o *GraphAPIComputeServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (GraphAPIComputeServiceResourceProperties) MarshalJSON

func (*GraphAPIComputeServiceResourceProperties) SetCreationTimeAsTime

func (o *GraphAPIComputeServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

type MaterializedViewsBuilderServiceResourceProperties

type MaterializedViewsBuilderServiceResourceProperties struct {
	Locations *[]RegionalServiceResource `json:"locations,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*MaterializedViewsBuilderServiceResourceProperties) GetCreationTimeAsTime

func (o *MaterializedViewsBuilderServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (MaterializedViewsBuilderServiceResourceProperties) MarshalJSON

func (*MaterializedViewsBuilderServiceResourceProperties) SetCreationTimeAsTime

func (o *MaterializedViewsBuilderServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

type RawServiceResourcePropertiesImpl

type RawServiceResourcePropertiesImpl struct {
	Type   string
	Values map[string]interface{}
}

RawServiceResourcePropertiesImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RegionalServiceResource

type RegionalServiceResource struct {
	Location *string        `json:"location,omitempty"`
	Name     *string        `json:"name,omitempty"`
	Status   *ServiceStatus `json:"status,omitempty"`
}

type ServiceCreateOperationResponse

type ServiceCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServiceResource
}

type ServiceDeleteOperationResponse

type ServiceDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ServiceGetOperationResponse

type ServiceGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServiceResource
}

type ServiceId

type ServiceId struct {
	SubscriptionId      string
	ResourceGroupName   string
	DatabaseAccountName string
	ServiceName         string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, databaseAccountName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Service ID

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type ServiceResource

type ServiceResource struct {
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties ServiceResourceProperties `json:"properties"`
	Type       *string                   `json:"type,omitempty"`
}

func (*ServiceResource) UnmarshalJSON

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

type ServiceResourceCreateUpdateParameters

type ServiceResourceCreateUpdateParameters struct {
	Properties *ServiceResourceCreateUpdateProperties `json:"properties,omitempty"`
}

type ServiceResourceCreateUpdateProperties

type ServiceResourceCreateUpdateProperties struct {
	InstanceCount *int64       `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize `json:"instanceSize,omitempty"`
	ServiceType   *ServiceType `json:"serviceType,omitempty"`
}

type ServiceResourceProperties

type ServiceResourceProperties interface {
}

type ServiceSize

type ServiceSize string
const (
	ServiceSizeCosmosPointDEights  ServiceSize = "Cosmos.D8s"
	ServiceSizeCosmosPointDFours   ServiceSize = "Cosmos.D4s"
	ServiceSizeCosmosPointDOneSixs ServiceSize = "Cosmos.D16s"
)

func (*ServiceSize) UnmarshalJSON added in v0.20240306.1111727

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

type ServiceStatus

type ServiceStatus string
const (
	ServiceStatusCreating ServiceStatus = "Creating"
	ServiceStatusDeleting ServiceStatus = "Deleting"
	ServiceStatusError    ServiceStatus = "Error"
	ServiceStatusRunning  ServiceStatus = "Running"
	ServiceStatusStopped  ServiceStatus = "Stopped"
	ServiceStatusUpdating ServiceStatus = "Updating"
)

func (*ServiceStatus) UnmarshalJSON added in v0.20240306.1111727

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

type ServiceType

type ServiceType string
const (
	ServiceTypeDataTransfer             ServiceType = "DataTransfer"
	ServiceTypeGraphAPICompute          ServiceType = "GraphAPICompute"
	ServiceTypeMaterializedViewsBuilder ServiceType = "MaterializedViewsBuilder"
	ServiceTypeSqlDedicatedGateway      ServiceType = "SqlDedicatedGateway"
)

func (*ServiceType) UnmarshalJSON added in v0.20240306.1111727

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

type SqlDedicatedGatewayRegionalServiceResource

type SqlDedicatedGatewayRegionalServiceResource struct {
	Location                    *string        `json:"location,omitempty"`
	Name                        *string        `json:"name,omitempty"`
	SqlDedicatedGatewayEndpoint *string        `json:"sqlDedicatedGatewayEndpoint,omitempty"`
	Status                      *ServiceStatus `json:"status,omitempty"`
}

type SqlDedicatedGatewayServiceResourceProperties

type SqlDedicatedGatewayServiceResourceProperties struct {
	Locations                   *[]SqlDedicatedGatewayRegionalServiceResource `json:"locations,omitempty"`
	SqlDedicatedGatewayEndpoint *string                                       `json:"sqlDedicatedGatewayEndpoint,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*SqlDedicatedGatewayServiceResourceProperties) GetCreationTimeAsTime

func (o *SqlDedicatedGatewayServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (SqlDedicatedGatewayServiceResourceProperties) MarshalJSON

func (*SqlDedicatedGatewayServiceResourceProperties) SetCreationTimeAsTime

func (o *SqlDedicatedGatewayServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL