path

package
v1.3.0-beta.1 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LeaseActionAcquire        = generated.LeaseActionAcquire
	LeaseActionRelease        = generated.LeaseActionRelease
	LeaseActionAcquireRelease = generated.LeaseActionAcquireRelease
	LeaseActionRenew          = generated.LeaseActionAutoRenew
)

Variables

This section is empty.

Functions

func FormatBlobHTTPHeaders 

func FormatBlobHTTPHeaders(o *HTTPHeaders) *blob.HTTPHeaders

func FormatDeleteOptions 

func FormatDeleteOptions(o *DeleteOptions, recursive bool) (*generated.LeaseAccessConditions, *generated.ModifiedAccessConditions, *generated.PathClientDeleteOptions)

func FormatGetAccessControlOptions 

func FormatGetAccessControlOptions(o *GetAccessControlOptions) (*generated.PathClientGetPropertiesOptions, *generated.LeaseAccessConditions, *generated.ModifiedAccessConditions)

func FormatGetPropertiesOptions 

func FormatGetPropertiesOptions(o *GetPropertiesOptions) *blob.GetPropertiesOptions

func FormatGetSASURLOptions 

func FormatGetSASURLOptions(o *GetSASURLOptions) time.Time

func FormatPathHTTPHeaders 

func FormatPathHTTPHeaders(o *HTTPHeaders) *generated.PathHTTPHeaders

func FormatRenameOptions 

func FormatRenameOptions(o *RenameOptions, path string) (*generated.LeaseAccessConditions, *generated.ModifiedAccessConditions, *generated.SourceModifiedAccessConditions, *generated.PathClientCreateOptions, *generated.CPKInfo)

func FormatSetAccessControlOptions 

func FormatSetAccessControlOptions(o *SetAccessControlOptions) (*generated.PathClientSetAccessControlOptions, *generated.LeaseAccessConditions, *generated.ModifiedAccessConditions, error)

func FormatSetHTTPHeadersOptions 

func FormatSetHTTPHeadersOptions(o *SetHTTPHeadersOptions, httpHeaders HTTPHeaders) (*blob.SetHTTPHeadersOptions, blob.HTTPHeaders)

func FormatSetHTTPHeadersResponse 

func FormatSetHTTPHeadersResponse(r *SetHTTPHeadersResponse, blobResp *blob.SetHTTPHeadersResponse)

func FormatSetMetadataOptions 

func FormatSetMetadataOptions(o *SetMetadataOptions) *blob.SetMetadataOptions

Types

type ACLFailedEntry 

type ACLFailedEntry = generated.ACLFailedEntry

ACLFailedEntry contains the failed ACL entry (response model).

type AccessConditions 

type AccessConditions = exported.AccessConditions

AccessConditions identifies access conditions which you optionally set.

type CPKInfo 

type CPKInfo struct {
	// EncryptionAlgorithm is the algorithm used to encrypt the data.
	EncryptionAlgorithm *EncryptionAlgorithmType
	// EncryptionKey is the base64 encoded encryption key.
	EncryptionKey *string
	// EncryptionKeySHA256 is the base64 encoded SHA256 of the encryption key.
	EncryptionKeySHA256 *string
}

CPKInfo contains CPK related information.

type CPKScopeInfo 

type CPKScopeInfo = blob.CPKScopeInfo

CPKScopeInfo contains a group of parameters for the Client.SetMetadata() method.

type CopyStatusType 

type CopyStatusType = blob.CopyStatusType

CopyStatusType defines values for CopyStatusType 

const (
	CopyStatusTypePending CopyStatusType = blob.CopyStatusTypePending
	CopyStatusTypeSuccess CopyStatusType = blob.CopyStatusTypeSuccess
	CopyStatusTypeAborted CopyStatusType = blob.CopyStatusTypeAborted
	CopyStatusTypeFailed  CopyStatusType = blob.CopyStatusTypeFailed
)

type CreateResponse 

type CreateResponse = generated.PathClientCreateResponse

CreateResponse contains the response fields for the Create operation.

type DeleteOptions 

type DeleteOptions struct {
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
	Paginated        *bool
}

DeleteOptions contains the optional parameters when calling the Delete operation.

type DeleteResponse 

type DeleteResponse = generated.PathClientDeleteResponse

DeleteResponse contains the response fields for the Delete operation.

type DurationType 

type DurationType = azdatalake.DurationType

DurationType defines values for DurationType 

const (
	DurationTypeInfinite DurationType = azdatalake.DurationTypeInfinite
	DurationTypeFixed    DurationType = azdatalake.DurationTypeFixed
)

func PossibleDurationTypeValues 

func PossibleDurationTypeValues() []DurationType

PossibleDurationTypeValues returns the possible values for the DurationType const type.

type EncryptionAlgorithmType 

type EncryptionAlgorithmType = generated.EncryptionAlgorithmType
const (
	EncryptionAlgorithmTypeNone   EncryptionAlgorithmType = generated.EncryptionAlgorithmTypeNone
	EncryptionAlgorithmTypeAES256 EncryptionAlgorithmType = generated.EncryptionAlgorithmTypeAES256
)

type GetAccessControlOptions 

type GetAccessControlOptions struct {
	// UPN is the user principal name.
	UPN *bool
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
}

GetAccessControlOptions contains the optional parameters when calling the GetAccessControl operation.

type GetAccessControlResponse 

type GetAccessControlResponse = generated.PathClientGetPropertiesResponse

GetAccessControlResponse contains the response fields for the GetAccessControl operation.

type GetPropertiesOptions 

type GetPropertiesOptions struct {
	AccessConditions *AccessConditions
	CPKInfo          *CPKInfo
}

GetPropertiesOptions contains the optional parameters for the Client.GetProperties method.

type GetPropertiesResponse 

type GetPropertiesResponse struct {
	// AcceptRanges contains the information returned from the Accept-Ranges header response.
	AcceptRanges *string

	// AccessControlList contains the combined list of access that are set for user, group and other on the file
	AccessControlList *string

	// AccessTier contains the information returned from the x-ms-access-tier header response.
	AccessTier *string

	// AccessTierChangeTime contains the information returned from the x-ms-access-tier-change-time header response.
	AccessTierChangeTime *time.Time

	// AccessTierInferred contains the information returned from the x-ms-access-tier-inferred header response.
	AccessTierInferred *bool

	// ArchiveStatus contains the information returned from the x-ms-archive-status header response.
	ArchiveStatus *string

	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// CopyCompletionTime contains the information returned from the x-ms-copy-completion-time header response.
	CopyCompletionTime *time.Time

	// CopyID contains the information returned from the x-ms-copy-id header response.
	CopyID *string

	// CopyProgress contains the information returned from the x-ms-copy-progress header response.
	CopyProgress *string

	// CopySource contains the information returned from the x-ms-copy-source header response.
	CopySource *string

	// CopyStatus contains the information returned from the x-ms-copy-status header response.
	CopyStatus *CopyStatusType

	// CopyStatusDescription contains the information returned from the x-ms-copy-status-description header response.
	CopyStatusDescription *string

	// CreationTime contains the information returned from the x-ms-creation-time header response.
	CreationTime *time.Time

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// DestinationSnapshot contains the information returned from the x-ms-copy-destination-snapshot header response.
	DestinationSnapshot *string

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// EncryptionScope contains the information returned from the x-ms-encryption-scope header response.
	EncryptionScope *string

	// EncryptionContext contains the information returned from the x-ms-encryption-context header response.
	EncryptionContext *string

	// ExpiresOn contains the information returned from the x-ms-expiry-time header response.
	ExpiresOn *time.Time

	// ImmutabilityPolicyExpiresOn contains the information returned from the x-ms-immutability-policy-until-date header response.
	ImmutabilityPolicyExpiresOn *time.Time

	// ImmutabilityPolicyMode contains the information returned from the x-ms-immutability-policy-mode header response.
	ImmutabilityPolicyMode *ImmutabilityPolicyMode

	// IsCurrentVersion contains the information returned from the x-ms-is-current-version header response.
	IsCurrentVersion *bool

	// IsIncrementalCopy contains the information returned from the x-ms-incremental-copy header response.
	IsIncrementalCopy *bool

	// IsSealed contains the information returned from the x-ms-blob-sealed header response.
	IsSealed *bool

	// IsServerEncrypted contains the information returned from the x-ms-server-encrypted header response.
	IsServerEncrypted *bool

	// LastAccessed contains the information returned from the x-ms-last-access-time header response.
	LastAccessed *time.Time

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *DurationType

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *StateType

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *StatusType

	// LegalHold contains the information returned from the x-ms-legal-hold header response.
	LegalHold *bool

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// ObjectReplicationPolicyID contains the information returned from the x-ms-or-policy-id header response.
	ObjectReplicationPolicyID *string

	// ObjectReplicationRules contains the information returned from the x-ms-or header response.
	ObjectReplicationRules map[string]*string

	// RehydratePriority contains the information returned from the x-ms-rehydrate-priority header response.
	RehydratePriority *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// TagCount contains the information returned from the x-ms-tag-count header response.
	TagCount *int64

	// Version contains the information returned from the x-ms-version header response.
	Version *string

	// VersionID contains the information returned from the x-ms-version-id header response.
	VersionID *string

	// Owner contains the information returned from the x-ms-owner header response.
	Owner *string

	// Group contains the information returned from the x-ms-group header response.
	Group *string

	// Permissions contains the information returned from the x-ms-permissions header response.
	Permissions *string

	// ResourceType contains the information returned from the x-ms-resource-type header response.
	ResourceType *string
}

GetPropertiesResponse contains the response fields for the GetProperties operation.

func FormatGetPropertiesResponse 

func FormatGetPropertiesResponse(r *blob.GetPropertiesResponse, rawResponse *http.Response) GetPropertiesResponse

type GetSASURLOptions 

type GetSASURLOptions struct {
	// StartTime is the start time for this SAS token.
	StartTime *time.Time
}

GetSASURLOptions contains the optional parameters for the Client.GetSASURL method.

type HTTPHeaders 

type HTTPHeaders struct {
	// CacheControl Sets the path's cache control. If specified, this property is stored with the path and returned with a read request.
	CacheControl *string
	// ContentDisposition Sets the path's Content-Disposition header.
	ContentDisposition *string
	// ContentEncoding Sets the path's content encoding. If specified, this property is stored with the path and returned with a read
	// request.
	ContentEncoding *string
	// ContentLanguage Set the path's content language. If specified, this property is stored with the path and returned with a read
	// request.
	ContentLanguage *string
	// ContentMD5 Specify the transactional md5 for the body, to be validated by the service.
	ContentMD5 []byte
	// ContentType Sets the path's content type. If specified, this property is stored with the path and returned with a read request.
	ContentType *string
}

HTTPHeaders contains the HTTP headers for path operations.

type ImmutabilityPolicyMode 

type ImmutabilityPolicyMode = blob.ImmutabilityPolicyMode
const (
	ImmutabilityPolicyModeMutable  ImmutabilityPolicyMode = blob.ImmutabilityPolicyModeMutable
	ImmutabilityPolicyModeUnlocked ImmutabilityPolicyMode = blob.ImmutabilityPolicyModeUnlocked
	ImmutabilityPolicyModeLocked   ImmutabilityPolicyMode = blob.ImmutabilityPolicyModeLocked
)

type LeaseAccessConditions 

type LeaseAccessConditions = exported.LeaseAccessConditions

LeaseAccessConditions contains optional parameters to access leased entity.

type LeaseAction added in v1.1.2 

type LeaseAction = generated.LeaseAction

type ModifiedAccessConditions 

type ModifiedAccessConditions = exported.ModifiedAccessConditions

ModifiedAccessConditions contains a group of parameters for specifying access conditions.

type RemoveAccessControlResponse 

type RemoveAccessControlResponse = generated.PathClientSetAccessControlRecursiveResponse

RemoveAccessControlResponse contains the response fields for the RemoveAccessControlRecursive operation.

type RenameOptions 

type RenameOptions struct {
	// SourceAccessConditions identifies the source path access conditions.
	SourceAccessConditions *SourceAccessConditions
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
	// CPKInfo contains CPK related information.
	CPKInfo *CPKInfo
}

RenameOptions contains the optional parameters when calling the Rename operation.

type RenameResponse 

type RenameResponse struct {
	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

func FormatRenameResponse 

func FormatRenameResponse(createResp *CreateResponse) RenameResponse

type SetAccessControlOptions 

type SetAccessControlOptions struct {
	// Owner is the owner of the path.
	Owner *string
	// Group is the owning group of the path.
	Group *string
	// ACL is the access control list for the path.
	ACL *string
	// Permissions is the octal representation of the permissions for user, group and mask.
	Permissions *string
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
}

SetAccessControlOptions contains the optional parameters when calling the SetAccessControl operation.

type SetAccessControlResponse 

type SetAccessControlResponse = generated.PathClientSetAccessControlResponse

SetAccessControlResponse contains the response fields for the SetAccessControl operation.

type SetHTTPHeadersOptions 

type SetHTTPHeadersOptions struct {
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
}

SetHTTPHeadersOptions contains the optional parameters for the Client.SetHTTPHeaders method.

type SetHTTPHeadersResponse 

type SetHTTPHeadersResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

SetHTTPHeadersResponse contains the response from method Client.SetHTTPHeaders.

type SetMetadataOptions 

type SetMetadataOptions struct {
	// AccessConditions contains parameters for accessing the path.
	AccessConditions *AccessConditions
	// CPKInfo contains CPK related information.
	CPKInfo *CPKInfo
	// CPKScopeInfo specifies the encryption scope settings.
	CPKScopeInfo *CPKScopeInfo
}

SetMetadataOptions provides set of configurations for Set Metadata on path operation

type SetMetadataResponse 

type SetMetadataResponse = blob.SetMetadataResponse

SetMetadataResponse contains the response fields for the SetMetadata operation.

type SharedKeyCredential 

type SharedKeyCredential = exported.SharedKeyCredential

SharedKeyCredential contains an account's name and its primary or secondary key.

type SourceAccessConditions 

type SourceAccessConditions = exported.SourceAccessConditions

SourceAccessConditions identifies source access conditions which you optionally set.

type SourceModifiedAccessConditions 

type SourceModifiedAccessConditions = exported.SourceModifiedAccessConditions

SourceModifiedAccessConditions contains a group of parameters for specifying access conditions.

type StateType 

type StateType = azdatalake.StateType

StateType defines values for StateType 

const (
	StateTypeAvailable StateType = azdatalake.StateTypeAvailable
	StateTypeLeased    StateType = azdatalake.StateTypeLeased
	StateTypeExpired   StateType = azdatalake.StateTypeExpired
	StateTypeBreaking  StateType = azdatalake.StateTypeBreaking
	StateTypeBroken    StateType = azdatalake.StateTypeBroken
)

type StatusType 

type StatusType = azdatalake.StatusType

StatusType defines values for StatusType 

const (
	StatusTypeLocked   StatusType = azdatalake.StatusTypeLocked
	StatusTypeUnlocked StatusType = azdatalake.StatusTypeUnlocked
)

func PossibleStatusTypeValues 

func PossibleStatusTypeValues() []StatusType

PossibleStatusTypeValues returns the possible values for the StatusType const type.

type UpdateAccessControlResponse 

type UpdateAccessControlResponse = generated.PathClientSetAccessControlRecursiveResponse

UpdateAccessControlResponse contains the response fields for the UpdateAccessControlRecursive operation.

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.