replicationevents

package
v0.20240521.1173452 Latest Latest
Warning

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

Go to latest
Published: May 21, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2024-02-01/replicationevents Documentation

The replicationevents SDK allows for interaction with the Azure Resource Manager Service recoveryservicessiterecovery (API Version 2024-02-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/recoveryservicessiterecovery/2024-02-01/replicationevents"

Client Initialization

client := replicationevents.NewReplicationEventsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationEventsClient.Get

ctx := context.TODO()
id := replicationevents.NewReplicationEventID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationEventValue")

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: ReplicationEventsClient.List

ctx := context.TODO()
id := replicationevents.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

// alternatively `client.List(ctx, id, replicationevents.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, replicationevents.DefaultListOperationOptions())
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 PossibleValuesForHealthErrorCustomerResolvability

func PossibleValuesForHealthErrorCustomerResolvability() []string

func ValidateReplicationEventID

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

ValidateReplicationEventID checks that 'input' can be parsed as a Replication Event ID

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type A2AEventDetails

type A2AEventDetails struct {
	FabricLocation       *string `json:"fabricLocation,omitempty"`
	FabricName           *string `json:"fabricName,omitempty"`
	FabricObjectId       *string `json:"fabricObjectId,omitempty"`
	ProtectedItemName    *string `json:"protectedItemName,omitempty"`
	RemoteFabricLocation *string `json:"remoteFabricLocation,omitempty"`
	RemoteFabricName     *string `json:"remoteFabricName,omitempty"`
}

func (A2AEventDetails) MarshalJSON

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

type Event

type Event struct {
	Id         *string          `json:"id,omitempty"`
	Location   *string          `json:"location,omitempty"`
	Name       *string          `json:"name,omitempty"`
	Properties *EventProperties `json:"properties,omitempty"`
	Type       *string          `json:"type,omitempty"`
}

type EventOperationPredicate

type EventOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (EventOperationPredicate) Matches

func (p EventOperationPredicate) Matches(input Event) bool

type EventProperties

type EventProperties struct {
	AffectedObjectCorrelationId *string                      `json:"affectedObjectCorrelationId,omitempty"`
	AffectedObjectFriendlyName  *string                      `json:"affectedObjectFriendlyName,omitempty"`
	Description                 *string                      `json:"description,omitempty"`
	EventCode                   *string                      `json:"eventCode,omitempty"`
	EventSpecificDetails        EventSpecificDetails         `json:"eventSpecificDetails"`
	EventType                   *string                      `json:"eventType,omitempty"`
	FabricId                    *string                      `json:"fabricId,omitempty"`
	HealthErrors                *[]HealthError               `json:"healthErrors,omitempty"`
	ProviderSpecificDetails     EventProviderSpecificDetails `json:"providerSpecificDetails"`
	Severity                    *string                      `json:"severity,omitempty"`
	TimeOfOccurrence            *string                      `json:"timeOfOccurrence,omitempty"`
}

func (*EventProperties) GetTimeOfOccurrenceAsTime

func (o *EventProperties) GetTimeOfOccurrenceAsTime() (*time.Time, error)

func (*EventProperties) SetTimeOfOccurrenceAsTime

func (o *EventProperties) SetTimeOfOccurrenceAsTime(input time.Time)

func (*EventProperties) UnmarshalJSON

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

type EventProviderSpecificDetails

type EventProviderSpecificDetails interface {
}

type EventSpecificDetails

type EventSpecificDetails interface {
}

type GetOperationResponse

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

type HealthError

type HealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	InnerHealthErrors            *[]InnerHealthError               `json:"innerHealthErrors,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*HealthError) GetCreationTimeUtcAsTime

func (o *HealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*HealthError) SetCreationTimeUtcAsTime

func (o *HealthError) SetCreationTimeUtcAsTime(input time.Time)

type HealthErrorCustomerResolvability

type HealthErrorCustomerResolvability string
const (
	HealthErrorCustomerResolvabilityAllowed    HealthErrorCustomerResolvability = "Allowed"
	HealthErrorCustomerResolvabilityNotAllowed HealthErrorCustomerResolvability = "NotAllowed"
)

func (*HealthErrorCustomerResolvability) UnmarshalJSON

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

type HyperVReplica2012EventDetails

type HyperVReplica2012EventDetails struct {
	ContainerName       *string `json:"containerName,omitempty"`
	FabricName          *string `json:"fabricName,omitempty"`
	RemoteContainerName *string `json:"remoteContainerName,omitempty"`
	RemoteFabricName    *string `json:"remoteFabricName,omitempty"`
}

func (HyperVReplica2012EventDetails) MarshalJSON

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

type HyperVReplica2012R2EventDetails

type HyperVReplica2012R2EventDetails struct {
	ContainerName       *string `json:"containerName,omitempty"`
	FabricName          *string `json:"fabricName,omitempty"`
	RemoteContainerName *string `json:"remoteContainerName,omitempty"`
	RemoteFabricName    *string `json:"remoteFabricName,omitempty"`
}

func (HyperVReplica2012R2EventDetails) MarshalJSON

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

type HyperVReplicaAzureEventDetails

type HyperVReplicaAzureEventDetails struct {
	ContainerName       *string `json:"containerName,omitempty"`
	FabricName          *string `json:"fabricName,omitempty"`
	RemoteContainerName *string `json:"remoteContainerName,omitempty"`
}

func (HyperVReplicaAzureEventDetails) MarshalJSON

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

type HyperVReplicaBaseEventDetails

type HyperVReplicaBaseEventDetails struct {
	ContainerName       *string `json:"containerName,omitempty"`
	FabricName          *string `json:"fabricName,omitempty"`
	RemoteContainerName *string `json:"remoteContainerName,omitempty"`
	RemoteFabricName    *string `json:"remoteFabricName,omitempty"`
}

func (HyperVReplicaBaseEventDetails) MarshalJSON

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

type InMageAzureV2EventDetails

type InMageAzureV2EventDetails struct {
	Category         *string `json:"category,omitempty"`
	Component        *string `json:"component,omitempty"`
	CorrectiveAction *string `json:"correctiveAction,omitempty"`
	Details          *string `json:"details,omitempty"`
	EventType        *string `json:"eventType,omitempty"`
	SiteName         *string `json:"siteName,omitempty"`
	Summary          *string `json:"summary,omitempty"`
}

func (InMageAzureV2EventDetails) MarshalJSON

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

type InMageRcmEventDetails

type InMageRcmEventDetails struct {
	ApplianceName        *string `json:"applianceName,omitempty"`
	ComponentDisplayName *string `json:"componentDisplayName,omitempty"`
	FabricName           *string `json:"fabricName,omitempty"`
	JobId                *string `json:"jobId,omitempty"`
	LatestAgentVersion   *string `json:"latestAgentVersion,omitempty"`
	ProtectedItemName    *string `json:"protectedItemName,omitempty"`
	ServerType           *string `json:"serverType,omitempty"`
	VirtualMachineName   *string `json:"vmName,omitempty"`
}

func (InMageRcmEventDetails) MarshalJSON

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

type InMageRcmFailbackEventDetails

type InMageRcmFailbackEventDetails struct {
	ApplianceName        *string `json:"applianceName,omitempty"`
	ComponentDisplayName *string `json:"componentDisplayName,omitempty"`
	ProtectedItemName    *string `json:"protectedItemName,omitempty"`
	ServerType           *string `json:"serverType,omitempty"`
	VirtualMachineName   *string `json:"vmName,omitempty"`
}

func (InMageRcmFailbackEventDetails) MarshalJSON

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

type InnerHealthError

type InnerHealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*InnerHealthError) GetCreationTimeUtcAsTime

func (o *InnerHealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*InnerHealthError) SetCreationTimeUtcAsTime

func (o *InnerHealthError) SetCreationTimeUtcAsTime(input time.Time)

type JobStatusEventDetails

type JobStatusEventDetails struct {
	AffectedObjectType *string `json:"affectedObjectType,omitempty"`
	JobFriendlyName    *string `json:"jobFriendlyName,omitempty"`
	JobId              *string `json:"jobId,omitempty"`
	JobStatus          *string `json:"jobStatus,omitempty"`
}

func (JobStatusEventDetails) MarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Event
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Event
}

type RawEventProviderSpecificDetailsImpl

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

RawEventProviderSpecificDetailsImpl 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 RawEventSpecificDetailsImpl

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

RawEventSpecificDetailsImpl 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 ReplicationEventId

type ReplicationEventId struct {
	SubscriptionId       string
	ResourceGroupName    string
	VaultName            string
	ReplicationEventName string
}

ReplicationEventId is a struct representing the Resource ID for a Replication Event

func NewReplicationEventID

func NewReplicationEventID(subscriptionId string, resourceGroupName string, vaultName string, replicationEventName string) ReplicationEventId

NewReplicationEventID returns a new ReplicationEventId struct

func ParseReplicationEventID

func ParseReplicationEventID(input string) (*ReplicationEventId, error)

ParseReplicationEventID parses 'input' into a ReplicationEventId

func ParseReplicationEventIDInsensitively

func ParseReplicationEventIDInsensitively(input string) (*ReplicationEventId, error)

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

func (*ReplicationEventId) FromParseResult

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

func (ReplicationEventId) ID

func (id ReplicationEventId) ID() string

ID returns the formatted Replication Event ID

func (ReplicationEventId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Replication Event ID

func (ReplicationEventId) String

func (id ReplicationEventId) String() string

String returns a human-readable description of this Replication Event ID

type ReplicationEventsClient

type ReplicationEventsClient struct {
	Client *resourcemanager.Client
}

func NewReplicationEventsClientWithBaseURI

func NewReplicationEventsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationEventsClient, error)

func (ReplicationEventsClient) Get

Get ...

func (ReplicationEventsClient) List

List ...

func (ReplicationEventsClient) ListComplete

ListComplete retrieves all the results into a single object

func (ReplicationEventsClient) ListCompleteMatchingPredicate

func (c ReplicationEventsClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, options ListOperationOptions, predicate EventOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type VMwareCbtEventDetails

type VMwareCbtEventDetails struct {
	MigrationItemName *string `json:"migrationItemName,omitempty"`
}

func (VMwareCbtEventDetails) MarshalJSON

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

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID

Jump to

Keyboard shortcuts

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