databox

package
v17.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package databox implements the Azure ARM Databox service API version 2018-01-01.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Databox
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccountCopyLogDetails 

type AccountCopyLogDetails struct {
	// AccountName - Destination account name.
	AccountName *string `json:"accountName,omitempty"`
	// CopyLogLink - Link for copy logs.
	CopyLogLink *string `json:"copyLogLink,omitempty"`
	// CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypePod', 'CopyLogDetailsTypeDisk'
	CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

AccountCopyLogDetails copy log details for an storage account

func (AccountCopyLogDetails) AsAccountCopyLogDetails 

func (acld AccountCopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsBasicCopyLogDetails 

func (acld AccountCopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsCopyLogDetails 

func (acld AccountCopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) AsDiskCopyLogDetails 

func (acld AccountCopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for AccountCopyLogDetails.

func (AccountCopyLogDetails) MarshalJSON 

func (acld AccountCopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCopyLogDetails.

type AccountCredentialDetails 

type AccountCredentialDetails struct {
	// AccountName - Name of the account.
	AccountName *string `json:"accountName,omitempty"`
	// ShareCredentialDetails - Per share level unencrypted access credentials.
	ShareCredentialDetails *[]ShareCredentialDetails `json:"shareCredentialDetails,omitempty"`
}

AccountCredentialDetails credential details of the account.

type AddressType 

type AddressType string

AddressType enumerates the values for address type. 

const (
	// Commercial ...
	Commercial AddressType = "Commercial"
	// None ...
	None AddressType = "None"
	// Residential ...
	Residential AddressType = "Residential"
)

func PossibleAddressTypeValues 

func PossibleAddressTypeValues() []AddressType

PossibleAddressTypeValues returns an array of possible values for the AddressType const type.

type AddressValidationOutput 

type AddressValidationOutput struct {
	autorest.Response `json:"-"`
	// AddressValidationProperties - The address validation properties.
	*AddressValidationProperties `json:"properties,omitempty"`
}

AddressValidationOutput output of the address validation api.

func (AddressValidationOutput) MarshalJSON 

func (avo AddressValidationOutput) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddressValidationOutput.

func (*AddressValidationOutput) UnmarshalJSON 

func (avo *AddressValidationOutput) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AddressValidationOutput struct.

type AddressValidationProperties 

type AddressValidationProperties struct {
	// ValidationStatus - The address validation status. Possible values include: 'Valid', 'Invalid', 'Ambiguous'
	ValidationStatus AddressValidationStatus `json:"validationStatus,omitempty"`
	// AlternateAddresses - List of alternate addresses.
	AlternateAddresses *[]ShippingAddress `json:"alternateAddresses,omitempty"`
}

AddressValidationProperties the address validation output.

type AddressValidationStatus 

type AddressValidationStatus string

AddressValidationStatus enumerates the values for address validation status. 

const (
	// Ambiguous ...
	Ambiguous AddressValidationStatus = "Ambiguous"
	// Invalid ...
	Invalid AddressValidationStatus = "Invalid"
	// Valid ...
	Valid AddressValidationStatus = "Valid"
)

func PossibleAddressValidationStatusValues 

func PossibleAddressValidationStatusValues() []AddressValidationStatus

PossibleAddressValidationStatusValues returns an array of possible values for the AddressValidationStatus const type.

type ArmBaseObject 

type ArmBaseObject struct {
	// Name - Name of the object.
	Name *string `json:"name,omitempty"`
	// ID - Id of the object.
	ID *string `json:"id,omitempty"`
	// Type - Type of the object.
	Type *string `json:"type,omitempty"`
}

ArmBaseObject base class for all objects under resource.

type AvailableSkuRequest 

type AvailableSkuRequest struct {
	// TransferType - Type of the transfer.
	TransferType *string `json:"transferType,omitempty"`
	// Country - ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
	Country *string `json:"country,omitempty"`
	// Location - Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
	Location *string `json:"location,omitempty"`
}

AvailableSkuRequest the filters for showing the available skus.

type AvailableSkusResult 

type AvailableSkusResult struct {
	autorest.Response `json:"-"`
	// Value - List of available skus.
	Value *[]SkuInformation `json:"value,omitempty"`
	// NextLink - Link for the next set of skus.
	NextLink *string `json:"nextLink,omitempty"`
}

AvailableSkusResult the available skus operation response.

func (AvailableSkusResult) IsEmpty 

func (asr AvailableSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AvailableSkusResultIterator 

type AvailableSkusResultIterator struct {
	// contains filtered or unexported fields
}

AvailableSkusResultIterator provides access to a complete listing of SkuInformation values.

func (*AvailableSkusResultIterator) Next 

func (iter *AvailableSkusResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AvailableSkusResultIterator) NotDone 

func (iter AvailableSkusResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AvailableSkusResultIterator) Response 

func (iter AvailableSkusResultIterator) Response() AvailableSkusResult

Response returns the raw server response from the last page request.

func (AvailableSkusResultIterator) Value 

func (iter AvailableSkusResultIterator) Value() SkuInformation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AvailableSkusResultPage 

type AvailableSkusResultPage struct {
	// contains filtered or unexported fields
}

AvailableSkusResultPage contains a page of SkuInformation values.

func (*AvailableSkusResultPage) Next 

func (page *AvailableSkusResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AvailableSkusResultPage) NotDone 

func (page AvailableSkusResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AvailableSkusResultPage) Response 

func (page AvailableSkusResultPage) Response() AvailableSkusResult

Response returns the raw server response from the last page request.

func (AvailableSkusResultPage) Values 

func (page AvailableSkusResultPage) Values() []SkuInformation

Values returns the slice of values for the current page or nil if there are no values.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Databox.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BasicCopyLogDetails 

type BasicCopyLogDetails interface {
	AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)
	AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)
	AsCopyLogDetails() (*CopyLogDetails, bool)
}

BasicCopyLogDetails details for log generated during copy.

type BasicJobDetails 

type BasicJobDetails interface {
	AsDiskJobDetails() (*DiskJobDetails, bool)
	AsPodJobDetails() (*PodJobDetails, bool)
	AsJobDetails() (*JobDetails, bool)
}

BasicJobDetails job details.

type BasicJobSecrets 

type BasicJobSecrets interface {
	AsCabinetJobSecrets() (*CabinetJobSecrets, bool)
	AsDiskJobSecrets() (*DiskJobSecrets, bool)
	AsPodJobSecrets() (*PodJobSecrets, bool)
	AsJobSecrets() (*JobSecrets, bool)
}

BasicJobSecrets the base class for the secrets

type CabinetJobSecrets 

type CabinetJobSecrets struct {
	// CabinetPodSecrets - Contains the list of secret objects for a cabinet job.
	CabinetPodSecrets *[]CabinetPodSecret `json:"cabinetPodSecrets,omitempty"`
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeCabinet', 'JobSecretsTypeDisk', 'JobSecretsTypePod'
	JobSecretsType JobSecretsType `json:"jobSecretsType,omitempty"`
}

CabinetJobSecrets the secrets related to a cabinet job.

func (CabinetJobSecrets) AsBasicJobSecrets 

func (cjs CabinetJobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for CabinetJobSecrets.

func (CabinetJobSecrets) AsCabinetJobSecrets 

func (cjs CabinetJobSecrets) AsCabinetJobSecrets() (*CabinetJobSecrets, bool)

AsCabinetJobSecrets is the BasicJobSecrets implementation for CabinetJobSecrets.

func (CabinetJobSecrets) AsDiskJobSecrets 

func (cjs CabinetJobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for CabinetJobSecrets.

func (CabinetJobSecrets) AsJobSecrets 

func (cjs CabinetJobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for CabinetJobSecrets.

func (CabinetJobSecrets) AsPodJobSecrets 

func (cjs CabinetJobSecrets) AsPodJobSecrets() (*PodJobSecrets, bool)

AsPodJobSecrets is the BasicJobSecrets implementation for CabinetJobSecrets.

func (CabinetJobSecrets) MarshalJSON 

func (cjs CabinetJobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CabinetJobSecrets.

type CabinetPodSecret 

type CabinetPodSecret struct {
	// DeviceSerialNumber - Serial number of the assigned device.
	DeviceSerialNumber *string `json:"deviceSerialNumber,omitempty"`
	// DevicePassword - Password for out of the box experience on device.
	DevicePassword *string `json:"devicePassword,omitempty"`
	// AccountCredentialDetails - Per account level access credentials.
	AccountCredentialDetails *[]AccountCredentialDetails `json:"accountCredentialDetails,omitempty"`
}

CabinetPodSecret the secrets related to a cabinet pod.

type CancellationReason 

type CancellationReason struct {
	// Reason - Reason for cancellation.
	Reason *string `json:"reason,omitempty"`
}

CancellationReason reason for cancellation.

type ContactDetails 

type ContactDetails struct {
	// ContactName - Contact name of the person.
	ContactName *string `json:"contactName,omitempty"`
	// Phone - Phone number of the contact person.
	Phone *string `json:"phone,omitempty"`
	// PhoneExtension - Phone extension number of the contact person.
	PhoneExtension *string `json:"phoneExtension,omitempty"`
	// Mobile - Mobile number of the contact person.
	Mobile *string `json:"mobile,omitempty"`
	// EmailList - List of Email-ids to be notified about job progress.
	EmailList *[]string `json:"emailList,omitempty"`
	// NotificationPreference - Notification preference for a job stage.
	NotificationPreference *[]NotificationPreference `json:"notificationPreference,omitempty"`
}

ContactDetails contact Details.

type CopyLogDetails 

type CopyLogDetails struct {
	// CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypePod', 'CopyLogDetailsTypeDisk'
	CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

CopyLogDetails details for log generated during copy.

func (CopyLogDetails) AsAccountCopyLogDetails 

func (cld CopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsBasicCopyLogDetails 

func (cld CopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsCopyLogDetails 

func (cld CopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) AsDiskCopyLogDetails 

func (cld CopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for CopyLogDetails.

func (CopyLogDetails) MarshalJSON 

func (cld CopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CopyLogDetails.

type CopyLogDetailsType 

type CopyLogDetailsType string

CopyLogDetailsType enumerates the values for copy log details type. 

const (
	// CopyLogDetailsTypeCopyLogDetails ...
	CopyLogDetailsTypeCopyLogDetails CopyLogDetailsType = "CopyLogDetails"
	// CopyLogDetailsTypeDisk ...
	CopyLogDetailsTypeDisk CopyLogDetailsType = "Disk"
	// CopyLogDetailsTypePod ...
	CopyLogDetailsTypePod CopyLogDetailsType = "Pod"
)

func PossibleCopyLogDetailsTypeValues 

func PossibleCopyLogDetailsTypeValues() []CopyLogDetailsType

PossibleCopyLogDetailsTypeValues returns an array of possible values for the CopyLogDetailsType const type.

type CopyProgress 

type CopyProgress struct {
	// StorageAccountName - Name of the storage account where the data needs to be uploaded.
	StorageAccountName *string `json:"storageAccountName,omitempty"`
	// BytesSentToCloud - Amount of data uploaded by the job as of now.
	BytesSentToCloud *int64 `json:"bytesSentToCloud,omitempty"`
	// TotalBytesToProcess - Total amount of data to be processed by the job.
	TotalBytesToProcess *int64 `json:"totalBytesToProcess,omitempty"`
}

CopyProgress copy progress.

type CopyStatus 

type CopyStatus string

CopyStatus enumerates the values for copy status. 

const (
	// Completed ...
	Completed CopyStatus = "Completed"
	// CompletedWithErrors ...
	CompletedWithErrors CopyStatus = "CompletedWithErrors"
	// Failed ...
	Failed CopyStatus = "Failed"
	// InProgress ...
	InProgress CopyStatus = "InProgress"
	// NotStarted ...
	NotStarted CopyStatus = "NotStarted"
)

func PossibleCopyStatusValues 

func PossibleCopyStatusValues() []CopyStatus

PossibleCopyStatusValues returns an array of possible values for the CopyStatus const type.

type DestinationAccountDetails 

type DestinationAccountDetails struct {
	// AccountID - Destination storage account id.
	AccountID *string `json:"accountId,omitempty"`
}

DestinationAccountDetails details for the destination account.

type DestinationToServiceLocationMap 

type DestinationToServiceLocationMap struct {
	// DestinationLocation - Location of the destination.
	DestinationLocation *string `json:"destinationLocation,omitempty"`
	// ServiceLocation - Location of the service.
	ServiceLocation *string `json:"serviceLocation,omitempty"`
}

DestinationToServiceLocationMap map of destination location to service location

type DeviceIssueType 

type DeviceIssueType string

DeviceIssueType enumerates the values for device issue type. 

const (
	// DeviceHealthCheckShowFailures ...
	DeviceHealthCheckShowFailures DeviceIssueType = "DeviceHealthCheckShowFailures"
	// DeviceNotBootingUp ...
	DeviceNotBootingUp DeviceIssueType = "DeviceNotBootingUp"
	// DeviceTampering ...
	DeviceTampering DeviceIssueType = "DeviceTampering"
	// Misc ...
	Misc DeviceIssueType = "Misc"
	// NICsAreNotWorking ...
	NICsAreNotWorking DeviceIssueType = "NICsAreNotWorking"
)

func PossibleDeviceIssueTypeValues 

func PossibleDeviceIssueTypeValues() []DeviceIssueType

PossibleDeviceIssueTypeValues returns an array of possible values for the DeviceIssueType const type.

type DeviceType 

type DeviceType string

DeviceType enumerates the values for device type. 

const (
	// Cabinet ...
	Cabinet DeviceType = "Cabinet"
	// Disk ...
	Disk DeviceType = "Disk"
	// Pod ...
	Pod DeviceType = "Pod"
)

func PossibleDeviceTypeValues 

func PossibleDeviceTypeValues() []DeviceType

PossibleDeviceTypeValues returns an array of possible values for the DeviceType const type.

type DiskCopyLogDetails 

type DiskCopyLogDetails struct {
	// DiskSerialNumber - Disk Serial Number.
	DiskSerialNumber *string `json:"diskSerialNumber,omitempty"`
	// ErrorLogLink - Link for copy error logs.
	ErrorLogLink *string `json:"errorLogLink,omitempty"`
	// VerboseLogLink - Link for copy verbose logs.
	VerboseLogLink *string `json:"verboseLogLink,omitempty"`
	// CopyLogDetailsType - Possible values include: 'CopyLogDetailsTypeCopyLogDetails', 'CopyLogDetailsTypePod', 'CopyLogDetailsTypeDisk'
	CopyLogDetailsType CopyLogDetailsType `json:"copyLogDetailsType,omitempty"`
}

DiskCopyLogDetails copy Log Details for a disk

func (DiskCopyLogDetails) AsAccountCopyLogDetails 

func (dcld DiskCopyLogDetails) AsAccountCopyLogDetails() (*AccountCopyLogDetails, bool)

AsAccountCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsBasicCopyLogDetails 

func (dcld DiskCopyLogDetails) AsBasicCopyLogDetails() (BasicCopyLogDetails, bool)

AsBasicCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsCopyLogDetails 

func (dcld DiskCopyLogDetails) AsCopyLogDetails() (*CopyLogDetails, bool)

AsCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) AsDiskCopyLogDetails 

func (dcld DiskCopyLogDetails) AsDiskCopyLogDetails() (*DiskCopyLogDetails, bool)

AsDiskCopyLogDetails is the BasicCopyLogDetails implementation for DiskCopyLogDetails.

func (DiskCopyLogDetails) MarshalJSON 

func (dcld DiskCopyLogDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskCopyLogDetails.

type DiskCopyProgress 

type DiskCopyProgress struct {
	// SerialNumber - The serial number of the disk
	SerialNumber *string `json:"serialNumber,omitempty"`
	// PercentComplete - Indicates the percentage completed for the copy of the disk.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// Status - The Status of the copy. Possible values include: 'NotStarted', 'InProgress', 'Completed', 'CompletedWithErrors', 'Failed'
	Status CopyStatus `json:"status,omitempty"`
}

DiskCopyProgress disk Copy Progress

type DiskJobDetails 

type DiskJobDetails struct {
	// PreferredDisks - User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.
	PreferredDisks map[string]*int32 `json:"preferredDisks"`
	// CopyProgress - Copy progress per disk.
	CopyProgress *[]DiskCopyProgress `json:"copyProgress,omitempty"`
	// DisksAndSizeDetails - Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.
	DisksAndSizeDetails map[string]*int32 `json:"disksAndSizeDetails"`
	// ExpectedDataSizeInTeraBytes - The expected size of the data, which needs to be transfered in this job, in tera bytes.
	ExpectedDataSizeInTeraBytes *int32 `json:"expectedDataSizeInTeraBytes,omitempty"`
	// JobStages - List of stages that run in the job.
	JobStages *[]JobStages `json:"jobStages,omitempty"`
	// ContactDetails - Contact details for notification and shipping.
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
	// ShippingAddress - Shipping address of the customer.
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// ErrorDetails - Error details for failure. This is optional.
	ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
	// JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDisk', 'JobDetailsTypePod'
	JobDetailsType JobDetailsType `json:"jobDetailsType,omitempty"`
}

DiskJobDetails disk Job Details.

func (DiskJobDetails) AsBasicJobDetails 

func (djd DiskJobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsDiskJobDetails 

func (djd DiskJobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsJobDetails 

func (djd DiskJobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) AsPodJobDetails 

func (djd DiskJobDetails) AsPodJobDetails() (*PodJobDetails, bool)

AsPodJobDetails is the BasicJobDetails implementation for DiskJobDetails.

func (DiskJobDetails) MarshalJSON 

func (djd DiskJobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskJobDetails.

type DiskJobSecrets 

type DiskJobSecrets struct {
	// DiskSecrets - Contains the list of secrets object for that device.
	DiskSecrets *[]DiskSecret `json:"diskSecrets,omitempty"`
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeCabinet', 'JobSecretsTypeDisk', 'JobSecretsTypePod'
	JobSecretsType JobSecretsType `json:"jobSecretsType,omitempty"`
}

DiskJobSecrets the secrets related to disk job.

func (DiskJobSecrets) AsBasicJobSecrets 

func (djs DiskJobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsCabinetJobSecrets 

func (djs DiskJobSecrets) AsCabinetJobSecrets() (*CabinetJobSecrets, bool)

AsCabinetJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsDiskJobSecrets 

func (djs DiskJobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsJobSecrets 

func (djs DiskJobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) AsPodJobSecrets 

func (djs DiskJobSecrets) AsPodJobSecrets() (*PodJobSecrets, bool)

AsPodJobSecrets is the BasicJobSecrets implementation for DiskJobSecrets.

func (DiskJobSecrets) MarshalJSON 

func (djs DiskJobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskJobSecrets.

type DiskSecret 

type DiskSecret struct {
	// DiskSerialNumber - Serial number of the assigned disk.
	DiskSerialNumber *string `json:"diskSerialNumber,omitempty"`
	// BitLockerKey - Bit Locker key of the disk which can be used to unlock the disk to copy data.
	BitLockerKey *string `json:"bitLockerKey,omitempty"`
}

DiskSecret contains all the secrets of a Disk.

type Error 

type Error struct {
	// Code - Error code that can be used to programmatically identify the error.
	Code *string `json:"code,omitempty"`
	// Message - Describes the error in detail and provides debugging information.
	Message *string `json:"message,omitempty"`
}

Error top level error for the job.

type GetCopyLogsURIOutput 

type GetCopyLogsURIOutput struct {
	autorest.Response `json:"-"`
	// LogType - Type/Level of the log.
	LogType *string `json:"logType,omitempty"`
	// CopyLogDetails - List of copy log details.
	CopyLogDetails *[]BasicCopyLogDetails `json:"copyLogDetails,omitempty"`
}

GetCopyLogsURIOutput output for the GetCopyLogsUri.

func (*GetCopyLogsURIOutput) UnmarshalJSON 

func (gcluo *GetCopyLogsURIOutput) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GetCopyLogsURIOutput struct.

type IssueType 

type IssueType string

IssueType enumerates the values for issue type. 

const (
	// CredentialNotWorking ...
	CredentialNotWorking IssueType = "CredentialNotWorking"
	// DeviceFailure ...
	DeviceFailure IssueType = "DeviceFailure"
	// DeviceMismatch ...
	DeviceMismatch IssueType = "DeviceMismatch"
	// ValidationStringMismatch ...
	ValidationStringMismatch IssueType = "ValidationStringMismatch"
)

func PossibleIssueTypeValues 

func PossibleIssueTypeValues() []IssueType

PossibleIssueTypeValues returns an array of possible values for the IssueType const type.

type JobDetails 

type JobDetails struct {
	// ExpectedDataSizeInTeraBytes - The expected size of the data, which needs to be transfered in this job, in tera bytes.
	ExpectedDataSizeInTeraBytes *int32 `json:"expectedDataSizeInTeraBytes,omitempty"`
	// JobStages - List of stages that run in the job.
	JobStages *[]JobStages `json:"jobStages,omitempty"`
	// ContactDetails - Contact details for notification and shipping.
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
	// ShippingAddress - Shipping address of the customer.
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// ErrorDetails - Error details for failure. This is optional.
	ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
	// JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDisk', 'JobDetailsTypePod'
	JobDetailsType JobDetailsType `json:"jobDetailsType,omitempty"`
}

JobDetails job details.

func (JobDetails) AsBasicJobDetails 

func (jd JobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsDiskJobDetails 

func (jd JobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsJobDetails 

func (jd JobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) AsPodJobDetails 

func (jd JobDetails) AsPodJobDetails() (*PodJobDetails, bool)

AsPodJobDetails is the BasicJobDetails implementation for JobDetails.

func (JobDetails) MarshalJSON 

func (jd JobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDetails.

type JobDetailsType 

type JobDetailsType string

JobDetailsType enumerates the values for job details type. 

const (
	// JobDetailsTypeDisk ...
	JobDetailsTypeDisk JobDetailsType = "Disk"
	// JobDetailsTypeJobDetails ...
	JobDetailsTypeJobDetails JobDetailsType = "JobDetails"
	// JobDetailsTypePod ...
	JobDetailsTypePod JobDetailsType = "Pod"
)

func PossibleJobDetailsTypeValues 

func PossibleJobDetailsTypeValues() []JobDetailsType

PossibleJobDetailsTypeValues returns an array of possible values for the JobDetailsType const type.

type JobErrorDetails 

type JobErrorDetails struct {
	// ErrorMessage - Message for the error.
	ErrorMessage *string `json:"errorMessage,omitempty"`
	// ErrorCode - Code for the error.
	ErrorCode *int32 `json:"errorCode,omitempty"`
	// RecommendedAction - Recommended action for the error.
	RecommendedAction *string `json:"recommendedAction,omitempty"`
	// ExceptionMessage - Contains the non localized exception message
	ExceptionMessage *string `json:"exceptionMessage,omitempty"`
}

JobErrorDetails job Error Details for providing the information and recommended action.

type JobProperties 

type JobProperties struct {
	// DeviceType - Type of the device to be used for the job. Possible values include: 'Pod', 'Disk', 'Cabinet'
	DeviceType DeviceType `json:"deviceType,omitempty"`
	// IsCancellable - Describes whether the job is cancellable or not.
	IsCancellable *bool `json:"isCancellable,omitempty"`
	// IsShippingAddressEditable - Describes whether the shipping address is editable or not.
	IsShippingAddressEditable *bool `json:"isShippingAddressEditable,omitempty"`
	// Status - Name of the stage which is in progress. Possible values include: 'StageNameDeviceOrdered', 'StageNameDevicePrepared', 'StageNameDispatched', 'StageNameDelivered', 'StageNamePickedUp', 'StageNameAtAzureDC', 'StageNameDataCopy', 'StageNameCompleted', 'StageNameCompletedWithErrors', 'StageNameCancelled', 'StageNameFailedIssueReportedAtCustomer', 'StageNameFailedIssueDetectedAtAzureDC', 'StageNameAborted'
	Status StageName `json:"status,omitempty"`
	// StartTime - Time at which the job was started in UTC ISO 8601 format.
	StartTime *date.Time `json:"startTime,omitempty"`
	// Error - Top level error for the job.
	Error *Error `json:"error,omitempty"`
	// DeliveryPackage - Delivery package shipping details.
	DeliveryPackage *PackageShippingDetails `json:"deliveryPackage,omitempty"`
	// ReturnPackage - Return package shipping details.
	ReturnPackage *PackageShippingDetails `json:"returnPackage,omitempty"`
	// DestinationAccountDetails - Destination account details.
	DestinationAccountDetails *[]DestinationAccountDetails `json:"destinationAccountDetails,omitempty"`
	// Details - Details of a job run. This field will only be sent for expand details filter.
	Details BasicJobDetails `json:"details,omitempty"`
	// CancellationReason - Reason for cancellation.
	CancellationReason *string `json:"cancellationReason,omitempty"`
}

JobProperties job Properties

func (*JobProperties) UnmarshalJSON 

func (jp *JobProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobProperties struct.

type JobResource 

type JobResource struct {
	autorest.Response `json:"-"`
	// JobProperties - Properties of a job.
	*JobProperties `json:"properties,omitempty"`
	// Name - Name of the object.
	Name *string `json:"name,omitempty"`
	// ID - Id of the object.
	ID *string `json:"id,omitempty"`
	// Type - Type of the object.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
	Tags map[string]*string `json:"tags"`
	// Sku - The sku type.
	Sku *Sku `json:"sku,omitempty"`
}

JobResource job Resource.

func (JobResource) MarshalJSON 

func (jr JobResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResource.

func (*JobResource) UnmarshalJSON 

func (jr *JobResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobResource struct.

type JobResourceList 

type JobResourceList struct {
	autorest.Response `json:"-"`
	// Value - List of job resources.
	Value *[]JobResource `json:"value,omitempty"`
	// NextLink - Link for the next set of job resources.
	NextLink *string `json:"nextLink,omitempty"`
}

JobResourceList job Resource Collection

func (JobResourceList) IsEmpty 

func (jrl JobResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobResourceListIterator 

type JobResourceListIterator struct {
	// contains filtered or unexported fields
}

JobResourceListIterator provides access to a complete listing of JobResource values.

func (*JobResourceListIterator) Next 

func (iter *JobResourceListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (JobResourceListIterator) NotDone 

func (iter JobResourceListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (JobResourceListIterator) Response 

func (iter JobResourceListIterator) Response() JobResourceList

Response returns the raw server response from the last page request.

func (JobResourceListIterator) Value 

func (iter JobResourceListIterator) Value() JobResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobResourceListPage 

type JobResourceListPage struct {
	// contains filtered or unexported fields
}

JobResourceListPage contains a page of JobResource values.

func (*JobResourceListPage) Next 

func (page *JobResourceListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (JobResourceListPage) NotDone 

func (page JobResourceListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (JobResourceListPage) Response 

func (page JobResourceListPage) Response() JobResourceList

Response returns the raw server response from the last page request.

func (JobResourceListPage) Values 

func (page JobResourceListPage) Values() []JobResource

Values returns the slice of values for the current page or nil if there are no values.

type JobResourceUpdateParameter 

type JobResourceUpdateParameter struct {
	// UpdateJobProperties - Properties of a job to be updated.
	*UpdateJobProperties `json:"properties,omitempty"`
	// Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
	Tags map[string]*string `json:"tags"`
}

JobResourceUpdateParameter the JobResourceUpdateParameter.

func (JobResourceUpdateParameter) MarshalJSON 

func (jrup JobResourceUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResourceUpdateParameter.

func (*JobResourceUpdateParameter) UnmarshalJSON 

func (jrup *JobResourceUpdateParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobResourceUpdateParameter struct.

type JobSecrets 

type JobSecrets struct {
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeCabinet', 'JobSecretsTypeDisk', 'JobSecretsTypePod'
	JobSecretsType JobSecretsType `json:"jobSecretsType,omitempty"`
}

JobSecrets the base class for the secrets

func (JobSecrets) AsBasicJobSecrets 

func (js JobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsCabinetJobSecrets 

func (js JobSecrets) AsCabinetJobSecrets() (*CabinetJobSecrets, bool)

AsCabinetJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsDiskJobSecrets 

func (js JobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsJobSecrets 

func (js JobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) AsPodJobSecrets 

func (js JobSecrets) AsPodJobSecrets() (*PodJobSecrets, bool)

AsPodJobSecrets is the BasicJobSecrets implementation for JobSecrets.

func (JobSecrets) MarshalJSON 

func (js JobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobSecrets.

type JobSecretsType 

type JobSecretsType string

JobSecretsType enumerates the values for job secrets type. 

const (
	// JobSecretsTypeCabinet ...
	JobSecretsTypeCabinet JobSecretsType = "Cabinet"
	// JobSecretsTypeDisk ...
	JobSecretsTypeDisk JobSecretsType = "Disk"
	// JobSecretsTypeJobSecrets ...
	JobSecretsTypeJobSecrets JobSecretsType = "JobSecrets"
	// JobSecretsTypePod ...
	JobSecretsTypePod JobSecretsType = "Pod"
)

func PossibleJobSecretsTypeValues 

func PossibleJobSecretsTypeValues() []JobSecretsType

PossibleJobSecretsTypeValues returns an array of possible values for the JobSecretsType const type.

type JobStages 

type JobStages struct {
	// StageName - Name of the job stage. Possible values include: 'StageNameDeviceOrdered', 'StageNameDevicePrepared', 'StageNameDispatched', 'StageNameDelivered', 'StageNamePickedUp', 'StageNameAtAzureDC', 'StageNameDataCopy', 'StageNameCompleted', 'StageNameCompletedWithErrors', 'StageNameCancelled', 'StageNameFailedIssueReportedAtCustomer', 'StageNameFailedIssueDetectedAtAzureDC', 'StageNameAborted'
	StageName StageName `json:"stageName,omitempty"`
	// DisplayName - Display name of the job stage.
	DisplayName *string `json:"displayName,omitempty"`
	// StageStatus - Status of the job stage. Possible values include: 'StageStatusNone', 'StageStatusInProgress', 'StageStatusSucceeded', 'StageStatusFailed', 'StageStatusCancelled', 'StageStatusCancelling', 'StageStatusSucceededWithErrors'
	StageStatus StageStatus `json:"stageStatus,omitempty"`
	// StageTime - Time for the job stage in UTC ISO 8601 format.
	StageTime *date.Time `json:"stageTime,omitempty"`
	// JobStageDetails - Job Stage Details
	JobStageDetails interface{} `json:"jobStageDetails,omitempty"`
	// ErrorDetails - Error details for the stage.
	ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
}

JobStages job stages.

type JobsClient 

type JobsClient struct {
	BaseClient
}

JobsClient is the client for the Jobs methods of the Databox service.

func NewJobsClient 

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI 

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) BookShipmentPickUp 

func (client JobsClient) BookShipmentPickUp(ctx context.Context, resourceGroupName string, jobName string, shipmentPickUpRequest ShipmentPickUpRequest) (result ShipmentPickUpResponse, err error)

BookShipmentPickUp book shipment pick up. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only shipmentPickUpRequest - details of shipment pick up request.

func (JobsClient) BookShipmentPickUpPreparer 

func (client JobsClient) BookShipmentPickUpPreparer(ctx context.Context, resourceGroupName string, jobName string, shipmentPickUpRequest ShipmentPickUpRequest) (*http.Request, error)

BookShipmentPickUpPreparer prepares the BookShipmentPickUp request.

func (JobsClient) BookShipmentPickUpResponder 

func (client JobsClient) BookShipmentPickUpResponder(resp *http.Response) (result ShipmentPickUpResponse, err error)

BookShipmentPickUpResponder handles the response to the BookShipmentPickUp request. The method always closes the http.Response Body.

func (JobsClient) BookShipmentPickUpSender 

func (client JobsClient) BookShipmentPickUpSender(req *http.Request) (*http.Response, error)

BookShipmentPickUpSender sends the BookShipmentPickUp request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Cancel 

func (client JobsClient) Cancel(ctx context.Context, resourceGroupName string, jobName string, cancellationReason CancellationReason) (result autorest.Response, err error)

Cancel cancelJob. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only cancellationReason - reason for cancellation.

func (JobsClient) CancelPreparer 

func (client JobsClient) CancelPreparer(ctx context.Context, resourceGroupName string, jobName string, cancellationReason CancellationReason) (*http.Request, error)

CancelPreparer prepares the Cancel request.

func (JobsClient) CancelResponder 

func (client JobsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)

CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.

func (JobsClient) CancelSender 

func (client JobsClient) CancelSender(req *http.Request) (*http.Response, error)

CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Create 

func (client JobsClient) Create(ctx context.Context, resourceGroupName string, jobName string, jobResource JobResource) (result JobsCreateFuture, err error)

Create creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only jobResource - job details from request body.

func (JobsClient) CreatePreparer 

func (client JobsClient) CreatePreparer(ctx context.Context, resourceGroupName string, jobName string, jobResource JobResource) (*http.Request, error)

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder 

func (client JobsClient) CreateResponder(resp *http.Response) (result JobResource, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (JobsClient) CreateSender 

func (client JobsClient) CreateSender(req *http.Request) (future JobsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Delete 

func (client JobsClient) Delete(ctx context.Context, resourceGroupName string, jobName string) (result autorest.Response, err error)

Delete deletes a job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) DeletePreparer 

func (client JobsClient) DeletePreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder 

func (client JobsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobsClient) DeleteSender 

func (client JobsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (JobsClient) DownloadShippingLabelURI 

func (client JobsClient) DownloadShippingLabelURI(ctx context.Context, resourceGroupName string, jobName string) (result ShippingLabelDetails, err error)

DownloadShippingLabelURI get shipping label sas uri. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) DownloadShippingLabelURIPreparer 

func (client JobsClient) DownloadShippingLabelURIPreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

DownloadShippingLabelURIPreparer prepares the DownloadShippingLabelURI request.

func (JobsClient) DownloadShippingLabelURIResponder 

func (client JobsClient) DownloadShippingLabelURIResponder(resp *http.Response) (result ShippingLabelDetails, err error)

DownloadShippingLabelURIResponder handles the response to the DownloadShippingLabelURI request. The method always closes the http.Response Body.

func (JobsClient) DownloadShippingLabelURISender 

func (client JobsClient) DownloadShippingLabelURISender(req *http.Request) (*http.Response, error)

DownloadShippingLabelURISender sends the DownloadShippingLabelURI request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Get 

func (client JobsClient) Get(ctx context.Context, resourceGroupName string, jobName string, expand string) (result JobResource, err error)

Get gets information about the specified job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only expand - $expand is supported on details parameter for job, which provides details on the job stages.

func (JobsClient) GetCopyLogsURI 

func (client JobsClient) GetCopyLogsURI(ctx context.Context, resourceGroupName string, jobName string) (result GetCopyLogsURIOutput, err error)

GetCopyLogsURI provides list of copy logs uri. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) GetCopyLogsURIPreparer 

func (client JobsClient) GetCopyLogsURIPreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

GetCopyLogsURIPreparer prepares the GetCopyLogsURI request.

func (JobsClient) GetCopyLogsURIResponder 

func (client JobsClient) GetCopyLogsURIResponder(resp *http.Response) (result GetCopyLogsURIOutput, err error)

GetCopyLogsURIResponder handles the response to the GetCopyLogsURI request. The method always closes the http.Response Body.

func (JobsClient) GetCopyLogsURISender 

func (client JobsClient) GetCopyLogsURISender(req *http.Request) (*http.Response, error)

GetCopyLogsURISender sends the GetCopyLogsURI request. The method will close the http.Response Body if it receives an error.

func (JobsClient) GetPreparer 

func (client JobsClient) GetPreparer(ctx context.Context, resourceGroupName string, jobName string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder 

func (client JobsClient) GetResponder(resp *http.Response) (result JobResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (JobsClient) GetSender 

func (client JobsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (JobsClient) List 

func (client JobsClient) List(ctx context.Context, skipToken string) (result JobResourceListPage, err error)

List lists all the jobs available under the subscription. Parameters: skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

func (JobsClient) ListByResourceGroup 

func (client JobsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result JobResourceListPage, err error)

ListByResourceGroup lists all the jobs available under the given resource group. Parameters: resourceGroupName - the Resource Group Name skipToken - $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.

func (JobsClient) ListByResourceGroupComplete 

func (client JobsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skipToken string) (result JobResourceListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListByResourceGroupPreparer 

func (client JobsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobsClient) ListByResourceGroupResponder 

func (client JobsClient) ListByResourceGroupResponder(resp *http.Response) (result JobResourceList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (JobsClient) ListByResourceGroupSender 

func (client JobsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListComplete 

func (client JobsClient) ListComplete(ctx context.Context, skipToken string) (result JobResourceListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (JobsClient) ListPreparer 

func (client JobsClient) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListResponder 

func (client JobsClient) ListResponder(resp *http.Response) (result JobResourceList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (JobsClient) ListSecrets 

func (client JobsClient) ListSecrets(ctx context.Context, resourceGroupName string, jobName string) (result UnencryptedSecrets, err error)

ListSecrets this method gets the unencrypted secrets related to the job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

func (JobsClient) ListSecretsPreparer 

func (client JobsClient) ListSecretsPreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

ListSecretsPreparer prepares the ListSecrets request.

func (JobsClient) ListSecretsResponder 

func (client JobsClient) ListSecretsResponder(resp *http.Response) (result UnencryptedSecrets, err error)

ListSecretsResponder handles the response to the ListSecrets request. The method always closes the http.Response Body.

func (JobsClient) ListSecretsSender 

func (client JobsClient) ListSecretsSender(req *http.Request) (*http.Response, error)

ListSecretsSender sends the ListSecrets request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListSender 

func (client JobsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ReportIssue 

func (client JobsClient) ReportIssue(ctx context.Context, resourceGroupName string, jobName string, reportIssueDetails ReportIssueDetails) (result autorest.Response, err error)

ReportIssue reports an issue. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only reportIssueDetails - details of reported issue.

func (JobsClient) ReportIssuePreparer 

func (client JobsClient) ReportIssuePreparer(ctx context.Context, resourceGroupName string, jobName string, reportIssueDetails ReportIssueDetails) (*http.Request, error)

ReportIssuePreparer prepares the ReportIssue request.

func (JobsClient) ReportIssueResponder 

func (client JobsClient) ReportIssueResponder(resp *http.Response) (result autorest.Response, err error)

ReportIssueResponder handles the response to the ReportIssue request. The method always closes the http.Response Body.

func (JobsClient) ReportIssueSender 

func (client JobsClient) ReportIssueSender(req *http.Request) (*http.Response, error)

ReportIssueSender sends the ReportIssue request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Update 

func (client JobsClient) Update(ctx context.Context, resourceGroupName string, jobName string, jobResourceUpdateParameter JobResourceUpdateParameter, ifMatch string) (result JobsUpdateFuture, err error)

Update updates the properties of an existing job. Parameters: resourceGroupName - the Resource Group Name jobName - the name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only jobResourceUpdateParameter - job update parameters from request body. ifMatch - defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

func (JobsClient) UpdatePreparer 

func (client JobsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, jobName string, jobResourceUpdateParameter JobResourceUpdateParameter, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (JobsClient) UpdateResponder 

func (client JobsClient) UpdateResponder(resp *http.Response) (result JobResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (JobsClient) UpdateSender 

func (client JobsClient) UpdateSender(req *http.Request) (future JobsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type JobsCreateFuture 

type JobsCreateFuture struct {
	azure.Future
}

JobsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*JobsCreateFuture) Result 

func (future *JobsCreateFuture) Result(client JobsClient) (jr JobResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type JobsUpdateFuture 

type JobsUpdateFuture struct {
	azure.Future
}

JobsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*JobsUpdateFuture) Result 

func (future *JobsUpdateFuture) Result(client JobsClient) (jr JobResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NotificationPreference 

type NotificationPreference struct {
	// StageName - Name of the stage. Possible values include: 'DevicePrepared', 'Dispatched', 'Delivered', 'PickedUp', 'AtAzureDC', 'DataCopy'
	StageName NotificationStageName `json:"stageName,omitempty"`
	// SendNotification - Notification is required or not.
	SendNotification *bool `json:"sendNotification,omitempty"`
}

NotificationPreference notification preference for a job stage.

type NotificationStageName 

type NotificationStageName string

NotificationStageName enumerates the values for notification stage name. 

const (
	// AtAzureDC ...
	AtAzureDC NotificationStageName = "AtAzureDC"
	// DataCopy ...
	DataCopy NotificationStageName = "DataCopy"
	// Delivered ...
	Delivered NotificationStageName = "Delivered"
	// DevicePrepared ...
	DevicePrepared NotificationStageName = "DevicePrepared"
	// Dispatched ...
	Dispatched NotificationStageName = "Dispatched"
	// PickedUp ...
	PickedUp NotificationStageName = "PickedUp"
)

func PossibleNotificationStageNameValues 

func PossibleNotificationStageNameValues() []NotificationStageName

PossibleNotificationStageNameValues returns an array of possible values for the NotificationStageName const type.

type Operation 

type Operation struct {
	// Name - Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}
	Name *string `json:"name,omitempty"`
	// Display - Operation display values.
	Display *OperationDisplay `json:"display,omitempty"`
	// Properties - Operation properties.
	Properties interface{} `json:"properties,omitempty"`
	// Origin - Origin of the operation. Can be : user|system|user,system
	Origin *string `json:"origin,omitempty"`
}

Operation operation entity.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource name.
	Resource *string `json:"resource,omitempty"`
	// Operation - Localized name of the operation for display purpose.
	Operation *string `json:"operation,omitempty"`
	// Description - Localized description of the operation for display purpose.
	Description *string `json:"description,omitempty"`
}

OperationDisplay operation display

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	// Value - List of operations.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - Link for the next set of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList operation Collection.

func (OperationList) IsEmpty 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

type OperationListIterator struct {
	// contains filtered or unexported fields
}

OperationListIterator provides access to a complete listing of Operation values.

func (*OperationListIterator) Next 

func (iter *OperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone 

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value 

func (iter OperationListIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage 

type OperationListPage struct {
	// contains filtered or unexported fields
}

OperationListPage contains a page of Operation values.

func (*OperationListPage) Next 

func (page *OperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListPage) NotDone 

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values 

func (page OperationListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Databox service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListPage, err error)

List this method gets all the operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PackageShippingDetails 

type PackageShippingDetails struct {
	// CarrierName - Name of the carrier.
	CarrierName *string `json:"carrierName,omitempty"`
	// TrackingID - Tracking Id of shipment.
	TrackingID *string `json:"trackingId,omitempty"`
	// TrackingURL - Url where shipment can be tracked.
	TrackingURL *string `json:"trackingUrl,omitempty"`
}

PackageShippingDetails shipping details.

type PodJobDetails 

type PodJobDetails struct {
	// CopyProgress - Copy progress per account.
	CopyProgress *[]CopyProgress `json:"copyProgress,omitempty"`
	// ExpectedDataSizeInTeraBytes - The expected size of the data, which needs to be transfered in this job, in tera bytes.
	ExpectedDataSizeInTeraBytes *int32 `json:"expectedDataSizeInTeraBytes,omitempty"`
	// JobStages - List of stages that run in the job.
	JobStages *[]JobStages `json:"jobStages,omitempty"`
	// ContactDetails - Contact details for notification and shipping.
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
	// ShippingAddress - Shipping address of the customer.
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// ErrorDetails - Error details for failure. This is optional.
	ErrorDetails *[]JobErrorDetails `json:"errorDetails,omitempty"`
	// JobDetailsType - Possible values include: 'JobDetailsTypeJobDetails', 'JobDetailsTypeDisk', 'JobDetailsTypePod'
	JobDetailsType JobDetailsType `json:"jobDetailsType,omitempty"`
}

PodJobDetails pod Job Details

func (PodJobDetails) AsBasicJobDetails 

func (pjd PodJobDetails) AsBasicJobDetails() (BasicJobDetails, bool)

AsBasicJobDetails is the BasicJobDetails implementation for PodJobDetails.

func (PodJobDetails) AsDiskJobDetails 

func (pjd PodJobDetails) AsDiskJobDetails() (*DiskJobDetails, bool)

AsDiskJobDetails is the BasicJobDetails implementation for PodJobDetails.

func (PodJobDetails) AsJobDetails 

func (pjd PodJobDetails) AsJobDetails() (*JobDetails, bool)

AsJobDetails is the BasicJobDetails implementation for PodJobDetails.

func (PodJobDetails) AsPodJobDetails 

func (pjd PodJobDetails) AsPodJobDetails() (*PodJobDetails, bool)

AsPodJobDetails is the BasicJobDetails implementation for PodJobDetails.

func (PodJobDetails) MarshalJSON 

func (pjd PodJobDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PodJobDetails.

type PodJobSecrets 

type PodJobSecrets struct {
	// PodSecrets - Contains the list of secret objects for a job.
	PodSecrets *[]PodSecret `json:"podSecrets,omitempty"`
	// JobSecretsType - Possible values include: 'JobSecretsTypeJobSecrets', 'JobSecretsTypeCabinet', 'JobSecretsTypeDisk', 'JobSecretsTypePod'
	JobSecretsType JobSecretsType `json:"jobSecretsType,omitempty"`
}

PodJobSecrets the secrets related to a pod job.

func (PodJobSecrets) AsBasicJobSecrets 

func (pjs PodJobSecrets) AsBasicJobSecrets() (BasicJobSecrets, bool)

AsBasicJobSecrets is the BasicJobSecrets implementation for PodJobSecrets.

func (PodJobSecrets) AsCabinetJobSecrets 

func (pjs PodJobSecrets) AsCabinetJobSecrets() (*CabinetJobSecrets, bool)

AsCabinetJobSecrets is the BasicJobSecrets implementation for PodJobSecrets.

func (PodJobSecrets) AsDiskJobSecrets 

func (pjs PodJobSecrets) AsDiskJobSecrets() (*DiskJobSecrets, bool)

AsDiskJobSecrets is the BasicJobSecrets implementation for PodJobSecrets.

func (PodJobSecrets) AsJobSecrets 

func (pjs PodJobSecrets) AsJobSecrets() (*JobSecrets, bool)

AsJobSecrets is the BasicJobSecrets implementation for PodJobSecrets.

func (PodJobSecrets) AsPodJobSecrets 

func (pjs PodJobSecrets) AsPodJobSecrets() (*PodJobSecrets, bool)

AsPodJobSecrets is the BasicJobSecrets implementation for PodJobSecrets.

func (PodJobSecrets) MarshalJSON 

func (pjs PodJobSecrets) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PodJobSecrets.

type PodSecret 

type PodSecret struct {
	// DeviceSerialNumber - Serial number of the assigned device.
	DeviceSerialNumber *string `json:"deviceSerialNumber,omitempty"`
	// DevicePassword - Password for out of the box experience on device.
	DevicePassword *string `json:"devicePassword,omitempty"`
	// AccountCredentialDetails - Per account level access credentials.
	AccountCredentialDetails *[]AccountCredentialDetails `json:"accountCredentialDetails,omitempty"`
}

PodSecret the secrets related to a Pod.

type ReportIssueDetails 

type ReportIssueDetails struct {
	// IssueType - Issue Type. Possible values include: 'DeviceMismatch', 'ValidationStringMismatch', 'CredentialNotWorking', 'DeviceFailure'
	IssueType IssueType `json:"issueType,omitempty"`
	// DeviceIssueType - Device Issue Type. Only used for Device failure issue. Possible values include: 'DeviceTampering', 'DeviceNotBootingUp', 'DeviceHealthCheckShowFailures', 'NICsAreNotWorking', 'Misc'
	DeviceIssueType DeviceIssueType `json:"deviceIssueType,omitempty"`
}

ReportIssueDetails details of the reported issue.

type Resource 

type Resource struct {
	// Location - The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
	Tags map[string]*string `json:"tags"`
	// Sku - The sku type.
	Sku *Sku `json:"sku,omitempty"`
}

Resource model of the Resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ServiceClient 

type ServiceClient struct {
	BaseClient
}

ServiceClient is the client for the Service methods of the Databox service.

func NewServiceClient 

func NewServiceClient(subscriptionID string) ServiceClient

NewServiceClient creates an instance of the ServiceClient client.

func NewServiceClientWithBaseURI 

func NewServiceClientWithBaseURI(baseURI string, subscriptionID string) ServiceClient

NewServiceClientWithBaseURI creates an instance of the ServiceClient client.

func (ServiceClient) ListAvailableSkus 

func (client ServiceClient) ListAvailableSkus(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultPage, err error)

ListAvailableSkus this method provides the list of available skus for the given subscription and location. Parameters: location - the location of the resource availableSkuRequest - filters for showing the available skus.

func (ServiceClient) ListAvailableSkusComplete 

func (client ServiceClient) ListAvailableSkusComplete(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (result AvailableSkusResultIterator, err error)

ListAvailableSkusComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceClient) ListAvailableSkusPreparer 

func (client ServiceClient) ListAvailableSkusPreparer(ctx context.Context, location string, availableSkuRequest AvailableSkuRequest) (*http.Request, error)

ListAvailableSkusPreparer prepares the ListAvailableSkus request.

func (ServiceClient) ListAvailableSkusResponder 

func (client ServiceClient) ListAvailableSkusResponder(resp *http.Response) (result AvailableSkusResult, err error)

ListAvailableSkusResponder handles the response to the ListAvailableSkus request. The method always closes the http.Response Body.

func (ServiceClient) ListAvailableSkusSender 

func (client ServiceClient) ListAvailableSkusSender(req *http.Request) (*http.Response, error)

ListAvailableSkusSender sends the ListAvailableSkus request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) ValidateAddressMethod 

func (client ServiceClient) ValidateAddressMethod(ctx context.Context, location string, validateAddress ValidateAddress) (result AddressValidationOutput, err error)

ValidateAddressMethod this method validates the customer shipping address and provide alternate addresses if any. Parameters: location - the location of the resource validateAddress - shipping address of the customer.

func (ServiceClient) ValidateAddressMethodPreparer 

func (client ServiceClient) ValidateAddressMethodPreparer(ctx context.Context, location string, validateAddress ValidateAddress) (*http.Request, error)

ValidateAddressMethodPreparer prepares the ValidateAddressMethod request.

func (ServiceClient) ValidateAddressMethodResponder 

func (client ServiceClient) ValidateAddressMethodResponder(resp *http.Response) (result AddressValidationOutput, err error)

ValidateAddressMethodResponder handles the response to the ValidateAddressMethod request. The method always closes the http.Response Body.

func (ServiceClient) ValidateAddressMethodSender 

func (client ServiceClient) ValidateAddressMethodSender(req *http.Request) (*http.Response, error)

ValidateAddressMethodSender sends the ValidateAddressMethod request. The method will close the http.Response Body if it receives an error.

type ShareCredentialDetails 

type ShareCredentialDetails struct {
	// ShareName - Name of the share.
	ShareName *string `json:"shareName,omitempty"`
	// UserName - User name for the share.
	UserName *string `json:"userName,omitempty"`
	// Password - Password for the share.
	Password *string `json:"password,omitempty"`
}

ShareCredentialDetails credential details of the shares in account.

type ShipmentPickUpRequest 

type ShipmentPickUpRequest struct {
	// StartTime - Minimum date after which the pick up should commence, this must be in local time of pick up area.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - Maximum date before which the pick up should commence, this must be in local time of pick up area.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ShipmentLocation - Shipment Location in the pickup place. Eg.front desk
	ShipmentLocation *string `json:"shipmentLocation,omitempty"`
}

ShipmentPickUpRequest shipment pick up request details.

type ShipmentPickUpResponse 

type ShipmentPickUpResponse struct {
	autorest.Response `json:"-"`
	// ConfirmationNumber - Confirmation number for the pick up request.
	ConfirmationNumber *string `json:"confirmationNumber,omitempty"`
	// ReadyByTime - Time by which shipment should be ready for pick up, this is in local time of pick up area.
	ReadyByTime *date.Time `json:"readyByTime,omitempty"`
}

ShipmentPickUpResponse shipment pick up response.

type ShippingAddress 

type ShippingAddress struct {
	// StreetAddress1 - Street Address line 1.
	StreetAddress1 *string `json:"streetAddress1,omitempty"`
	// StreetAddress2 - Street Address line 2.
	StreetAddress2 *string `json:"streetAddress2,omitempty"`
	// StreetAddress3 - Street Address line 3.
	StreetAddress3 *string `json:"streetAddress3,omitempty"`
	// City - Name of the City.
	City *string `json:"city,omitempty"`
	// StateOrProvince - Name of the State or Province.
	StateOrProvince *string `json:"stateOrProvince,omitempty"`
	// Country - Name of the Country.
	Country *string `json:"country,omitempty"`
	// PostalCode - Postal code.
	PostalCode *string `json:"postalCode,omitempty"`
	// ZipExtendedCode - Extended Zip Code.
	ZipExtendedCode *string `json:"zipExtendedCode,omitempty"`
	// CompanyName - Name of the company.
	CompanyName *string `json:"companyName,omitempty"`
	// AddressType - Type of address. Possible values include: 'None', 'Residential', 'Commercial'
	AddressType AddressType `json:"addressType,omitempty"`
}

ShippingAddress shipping address where customer wishes to receive the device.

type ShippingLabelDetails 

type ShippingLabelDetails struct {
	autorest.Response `json:"-"`
	// ShippingLabelSasURI - Sas uri for accessing the shipping label.
	ShippingLabelSasURI *string `json:"shippingLabelSasUri,omitempty"`
}

ShippingLabelDetails details for the shipping label.

type Sku 

type Sku struct {
	// Name - The sku name.
	Name *string `json:"name,omitempty"`
	// DisplayName - The display name of the sku.
	DisplayName *string `json:"displayName,omitempty"`
	// Family - The sku family.
	Family *string `json:"family,omitempty"`
}

Sku the Sku.

type SkuCapacity 

type SkuCapacity struct {
	// Usable - Usable capacity in TB.
	Usable *string `json:"usable,omitempty"`
	// Maximum - Maximum capacity in TB.
	Maximum *string `json:"maximum,omitempty"`
}

SkuCapacity capacity of the sku.

type SkuCost 

type SkuCost struct {
	// MeterID - Meter id of the Sku.
	MeterID *string `json:"meterId,omitempty"`
	// MeterType - The type of the meter.
	MeterType *string `json:"meterType,omitempty"`
}

SkuCost describes metadata for retrieving price info.

type SkuInformation 

type SkuInformation struct {
	// Sku - The Sku.
	Sku *Sku `json:"sku,omitempty"`
	// Enabled - The sku is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`
	// SkuProperties - Properties of the sku.
	*SkuProperties `json:"properties,omitempty"`
}

SkuInformation information of the sku.

func (SkuInformation) MarshalJSON 

func (si SkuInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SkuInformation.

func (*SkuInformation) UnmarshalJSON 

func (si *SkuInformation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SkuInformation struct.

type SkuProperties 

type SkuProperties struct {
	// DestinationToServiceLocationMap - The map of destination location to service location.
	DestinationToServiceLocationMap *[]DestinationToServiceLocationMap `json:"destinationToServiceLocationMap,omitempty"`
	// Capacity - Capacity of the Sku.
	Capacity *SkuCapacity `json:"capacity,omitempty"`
	// Costs - Cost of the Sku.
	Costs *[]SkuCost `json:"costs,omitempty"`
	// APIVersions - Api versions that support this Sku.
	APIVersions *[]string `json:"apiVersions,omitempty"`
	// DisabledReason - Reason why the Sku is disabled.
	DisabledReason *string `json:"disabledReason,omitempty"`
}

SkuProperties properties of the sku.

type StageName 

type StageName string

StageName enumerates the values for stage name. 

const (
	// StageNameAborted ...
	StageNameAborted StageName = "Aborted"
	// StageNameAtAzureDC ...
	StageNameAtAzureDC StageName = "AtAzureDC"
	// StageNameCancelled ...
	StageNameCancelled StageName = "Cancelled"
	// StageNameCompleted ...
	StageNameCompleted StageName = "Completed"
	// StageNameCompletedWithErrors ...
	StageNameCompletedWithErrors StageName = "CompletedWithErrors"
	// StageNameDataCopy ...
	StageNameDataCopy StageName = "DataCopy"
	// StageNameDelivered ...
	StageNameDelivered StageName = "Delivered"
	// StageNameDeviceOrdered ...
	StageNameDeviceOrdered StageName = "DeviceOrdered"
	// StageNameDevicePrepared ...
	StageNameDevicePrepared StageName = "DevicePrepared"
	// StageNameDispatched ...
	StageNameDispatched StageName = "Dispatched"
	// StageNameFailedIssueDetectedAtAzureDC ...
	StageNameFailedIssueDetectedAtAzureDC StageName = "Failed_IssueDetectedAtAzureDC"
	// StageNameFailedIssueReportedAtCustomer ...
	StageNameFailedIssueReportedAtCustomer StageName = "Failed_IssueReportedAtCustomer"
	// StageNamePickedUp ...
	StageNamePickedUp StageName = "PickedUp"
)

func PossibleStageNameValues 

func PossibleStageNameValues() []StageName

PossibleStageNameValues returns an array of possible values for the StageName const type.

type StageStatus 

type StageStatus string

StageStatus enumerates the values for stage status. 

const (
	// StageStatusCancelled ...
	StageStatusCancelled StageStatus = "Cancelled"
	// StageStatusCancelling ...
	StageStatusCancelling StageStatus = "Cancelling"
	// StageStatusFailed ...
	StageStatusFailed StageStatus = "Failed"
	// StageStatusInProgress ...
	StageStatusInProgress StageStatus = "InProgress"
	// StageStatusNone ...
	StageStatusNone StageStatus = "None"
	// StageStatusSucceeded ...
	StageStatusSucceeded StageStatus = "Succeeded"
	// StageStatusSucceededWithErrors ...
	StageStatusSucceededWithErrors StageStatus = "SucceededWithErrors"
)

func PossibleStageStatusValues 

func PossibleStageStatusValues() []StageStatus

PossibleStageStatusValues returns an array of possible values for the StageStatus const type.

type UnencryptedSecrets 

type UnencryptedSecrets struct {
	autorest.Response `json:"-"`
	// JobName - Name of the job.
	JobName *string `json:"jobName,omitempty"`
	// DeviceType - The Device Type used in the job. Possible values include: 'Pod', 'Disk', 'Cabinet'
	DeviceType DeviceType `json:"deviceType,omitempty"`
	// JobSecrets - Secrets related to this job.
	JobSecrets BasicJobSecrets `json:"jobSecrets,omitempty"`
}

UnencryptedSecrets unencrypted secrets for accessing device.

func (*UnencryptedSecrets) UnmarshalJSON 

func (us *UnencryptedSecrets) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UnencryptedSecrets struct.

type UpdateJobDetails 

type UpdateJobDetails struct {
	// ContactDetails - Contact details for notification and shipping.
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`
	// ShippingAddress - Shipping address of the customer.
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
}

UpdateJobDetails job details for update.

type UpdateJobProperties 

type UpdateJobProperties struct {
	// Details - Details of a job to be updated.
	Details *UpdateJobDetails `json:"details,omitempty"`
}

UpdateJobProperties job Properties for update

type ValidateAddress 

type ValidateAddress struct {
	// ShippingAddress - Shipping address of the customer.
	ShippingAddress *ShippingAddress `json:"shippingAddress,omitempty"`
	// DeviceType - Device type to be used for the job. Possible values include: 'Pod', 'Disk', 'Cabinet'
	DeviceType DeviceType `json:"deviceType,omitempty"`
}

ValidateAddress the requirements to validate customer address where the device needs to be shipped.

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.