Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterStorageServer(s grpc.ServiceRegistrar, srv StorageServer)
- type AppendObjectSpec
- func (*AppendObjectSpec) Descriptor() ([]byte, []int)deprecated
- func (x *AppendObjectSpec) GetBucket() string
- func (x *AppendObjectSpec) GetGeneration() int64
- func (x *AppendObjectSpec) GetIfMetagenerationMatch() int64
- func (x *AppendObjectSpec) GetIfMetagenerationNotMatch() int64
- func (x *AppendObjectSpec) GetObject() string
- func (x *AppendObjectSpec) GetRoutingToken() string
- func (x *AppendObjectSpec) GetWriteHandle() *BidiWriteHandle
- func (*AppendObjectSpec) ProtoMessage()
- func (x *AppendObjectSpec) ProtoReflect() protoreflect.Message
- func (x *AppendObjectSpec) Reset()
- func (x *AppendObjectSpec) String() string
- type BidiReadHandle
- type BidiReadObjectError
- func (*BidiReadObjectError) Descriptor() ([]byte, []int)deprecated
- func (x *BidiReadObjectError) GetReadRangeErrors() []*ReadRangeError
- func (*BidiReadObjectError) ProtoMessage()
- func (x *BidiReadObjectError) ProtoReflect() protoreflect.Message
- func (x *BidiReadObjectError) Reset()
- func (x *BidiReadObjectError) String() string
- type BidiReadObjectRedirectedError
- func (*BidiReadObjectRedirectedError) Descriptor() ([]byte, []int)deprecated
- func (x *BidiReadObjectRedirectedError) GetReadHandle() *BidiReadHandle
- func (x *BidiReadObjectRedirectedError) GetRoutingToken() string
- func (*BidiReadObjectRedirectedError) ProtoMessage()
- func (x *BidiReadObjectRedirectedError) ProtoReflect() protoreflect.Message
- func (x *BidiReadObjectRedirectedError) Reset()
- func (x *BidiReadObjectRedirectedError) String() string
- type BidiReadObjectRequest
- func (*BidiReadObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *BidiReadObjectRequest) GetReadObjectSpec() *BidiReadObjectSpec
- func (x *BidiReadObjectRequest) GetReadRanges() []*ReadRange
- func (*BidiReadObjectRequest) ProtoMessage()
- func (x *BidiReadObjectRequest) ProtoReflect() protoreflect.Message
- func (x *BidiReadObjectRequest) Reset()
- func (x *BidiReadObjectRequest) String() string
- type BidiReadObjectResponse
- func (*BidiReadObjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *BidiReadObjectResponse) GetMetadata() *Object
- func (x *BidiReadObjectResponse) GetObjectDataRanges() []*ObjectRangeData
- func (x *BidiReadObjectResponse) GetReadHandle() *BidiReadHandle
- func (*BidiReadObjectResponse) ProtoMessage()
- func (x *BidiReadObjectResponse) ProtoReflect() protoreflect.Message
- func (x *BidiReadObjectResponse) Reset()
- func (x *BidiReadObjectResponse) String() string
- type BidiReadObjectSpec
- func (*BidiReadObjectSpec) Descriptor() ([]byte, []int)deprecated
- func (x *BidiReadObjectSpec) GetBucket() string
- func (x *BidiReadObjectSpec) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *BidiReadObjectSpec) GetGeneration() int64
- func (x *BidiReadObjectSpec) GetIfGenerationMatch() int64
- func (x *BidiReadObjectSpec) GetIfGenerationNotMatch() int64
- func (x *BidiReadObjectSpec) GetIfMetagenerationMatch() int64
- func (x *BidiReadObjectSpec) GetIfMetagenerationNotMatch() int64
- func (x *BidiReadObjectSpec) GetObject() string
- func (x *BidiReadObjectSpec) GetReadHandle() *BidiReadHandle
- func (x *BidiReadObjectSpec) GetReadMask() *fieldmaskpb.FieldMaskdeprecated
- func (x *BidiReadObjectSpec) GetRoutingToken() string
- func (*BidiReadObjectSpec) ProtoMessage()
- func (x *BidiReadObjectSpec) ProtoReflect() protoreflect.Message
- func (x *BidiReadObjectSpec) Reset()
- func (x *BidiReadObjectSpec) String() string
- type BidiWriteHandle
- type BidiWriteObjectRedirectedError
- func (*BidiWriteObjectRedirectedError) Descriptor() ([]byte, []int)deprecated
- func (x *BidiWriteObjectRedirectedError) GetGeneration() int64
- func (x *BidiWriteObjectRedirectedError) GetRoutingToken() string
- func (x *BidiWriteObjectRedirectedError) GetWriteHandle() *BidiWriteHandle
- func (*BidiWriteObjectRedirectedError) ProtoMessage()
- func (x *BidiWriteObjectRedirectedError) ProtoReflect() protoreflect.Message
- func (x *BidiWriteObjectRedirectedError) Reset()
- func (x *BidiWriteObjectRedirectedError) String() string
- type BidiWriteObjectRequest
- func (*BidiWriteObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *BidiWriteObjectRequest) GetAppendObjectSpec() *AppendObjectSpec
- func (x *BidiWriteObjectRequest) GetChecksummedData() *ChecksummedData
- func (x *BidiWriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (m *BidiWriteObjectRequest) GetData() isBidiWriteObjectRequest_Data
- func (x *BidiWriteObjectRequest) GetFinishWrite() bool
- func (m *BidiWriteObjectRequest) GetFirstMessage() isBidiWriteObjectRequest_FirstMessage
- func (x *BidiWriteObjectRequest) GetFlush() bool
- func (x *BidiWriteObjectRequest) GetObjectChecksums() *ObjectChecksums
- func (x *BidiWriteObjectRequest) GetStateLookup() bool
- func (x *BidiWriteObjectRequest) GetUploadId() string
- func (x *BidiWriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec
- func (x *BidiWriteObjectRequest) GetWriteOffset() int64
- func (*BidiWriteObjectRequest) ProtoMessage()
- func (x *BidiWriteObjectRequest) ProtoReflect() protoreflect.Message
- func (x *BidiWriteObjectRequest) Reset()
- func (x *BidiWriteObjectRequest) String() string
- type BidiWriteObjectRequest_AppendObjectSpec
- type BidiWriteObjectRequest_ChecksummedData
- type BidiWriteObjectRequest_UploadId
- type BidiWriteObjectRequest_WriteObjectSpec
- type BidiWriteObjectResponse
- func (*BidiWriteObjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *BidiWriteObjectResponse) GetPersistedSize() int64
- func (x *BidiWriteObjectResponse) GetResource() *Object
- func (x *BidiWriteObjectResponse) GetWriteHandle() *BidiWriteHandle
- func (m *BidiWriteObjectResponse) GetWriteStatus() isBidiWriteObjectResponse_WriteStatus
- func (*BidiWriteObjectResponse) ProtoMessage()
- func (x *BidiWriteObjectResponse) ProtoReflect() protoreflect.Message
- func (x *BidiWriteObjectResponse) Reset()
- func (x *BidiWriteObjectResponse) String() string
- type BidiWriteObjectResponse_PersistedSize
- type BidiWriteObjectResponse_Resource
- type Bucket
- func (*Bucket) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket) GetAcl() []*BucketAccessControl
- func (x *Bucket) GetAutoclass() *Bucket_Autoclass
- func (x *Bucket) GetBilling() *Bucket_Billing
- func (x *Bucket) GetBucketId() string
- func (x *Bucket) GetCors() []*Bucket_Cors
- func (x *Bucket) GetCreateTime() *timestamppb.Timestamp
- func (x *Bucket) GetCustomPlacementConfig() *Bucket_CustomPlacementConfig
- func (x *Bucket) GetDefaultEventBasedHold() bool
- func (x *Bucket) GetDefaultObjectAcl() []*ObjectAccessControl
- func (x *Bucket) GetEncryption() *Bucket_Encryption
- func (x *Bucket) GetEtag() string
- func (x *Bucket) GetHierarchicalNamespace() *Bucket_HierarchicalNamespace
- func (x *Bucket) GetIamConfig() *Bucket_IamConfig
- func (x *Bucket) GetIpFilter() *Bucket_IpFilter
- func (x *Bucket) GetLabels() map[string]string
- func (x *Bucket) GetLifecycle() *Bucket_Lifecycle
- func (x *Bucket) GetLocation() string
- func (x *Bucket) GetLocationType() string
- func (x *Bucket) GetLogging() *Bucket_Logging
- func (x *Bucket) GetMetageneration() int64
- func (x *Bucket) GetName() string
- func (x *Bucket) GetObjectRetention() *Bucket_ObjectRetention
- func (x *Bucket) GetOwner() *Owner
- func (x *Bucket) GetProject() string
- func (x *Bucket) GetRetentionPolicy() *Bucket_RetentionPolicy
- func (x *Bucket) GetRpo() string
- func (x *Bucket) GetSatisfiesPzs() bool
- func (x *Bucket) GetSoftDeletePolicy() *Bucket_SoftDeletePolicy
- func (x *Bucket) GetStorageClass() string
- func (x *Bucket) GetUpdateTime() *timestamppb.Timestamp
- func (x *Bucket) GetVersioning() *Bucket_Versioning
- func (x *Bucket) GetWebsite() *Bucket_Website
- func (*Bucket) ProtoMessage()
- func (x *Bucket) ProtoReflect() protoreflect.Message
- func (x *Bucket) Reset()
- func (x *Bucket) String() string
- type BucketAccessControl
- func (*BucketAccessControl) Descriptor() ([]byte, []int)deprecated
- func (x *BucketAccessControl) GetDomain() string
- func (x *BucketAccessControl) GetEmail() string
- func (x *BucketAccessControl) GetEntity() string
- func (x *BucketAccessControl) GetEntityAlt() string
- func (x *BucketAccessControl) GetEntityId() string
- func (x *BucketAccessControl) GetEtag() string
- func (x *BucketAccessControl) GetId() string
- func (x *BucketAccessControl) GetProjectTeam() *ProjectTeam
- func (x *BucketAccessControl) GetRole() string
- func (*BucketAccessControl) ProtoMessage()
- func (x *BucketAccessControl) ProtoReflect() protoreflect.Message
- func (x *BucketAccessControl) Reset()
- func (x *BucketAccessControl) String() string
- type Bucket_Autoclass
- func (*Bucket_Autoclass) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Autoclass) GetEnabled() bool
- func (x *Bucket_Autoclass) GetTerminalStorageClass() string
- func (x *Bucket_Autoclass) GetTerminalStorageClassUpdateTime() *timestamppb.Timestamp
- func (x *Bucket_Autoclass) GetToggleTime() *timestamppb.Timestamp
- func (*Bucket_Autoclass) ProtoMessage()
- func (x *Bucket_Autoclass) ProtoReflect() protoreflect.Message
- func (x *Bucket_Autoclass) Reset()
- func (x *Bucket_Autoclass) String() string
- type Bucket_Billing
- type Bucket_Cors
- func (*Bucket_Cors) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Cors) GetMaxAgeSeconds() int32
- func (x *Bucket_Cors) GetMethod() []string
- func (x *Bucket_Cors) GetOrigin() []string
- func (x *Bucket_Cors) GetResponseHeader() []string
- func (*Bucket_Cors) ProtoMessage()
- func (x *Bucket_Cors) ProtoReflect() protoreflect.Message
- func (x *Bucket_Cors) Reset()
- func (x *Bucket_Cors) String() string
- type Bucket_CustomPlacementConfig
- func (*Bucket_CustomPlacementConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_CustomPlacementConfig) GetDataLocations() []string
- func (*Bucket_CustomPlacementConfig) ProtoMessage()
- func (x *Bucket_CustomPlacementConfig) ProtoReflect() protoreflect.Message
- func (x *Bucket_CustomPlacementConfig) Reset()
- func (x *Bucket_CustomPlacementConfig) String() string
- type Bucket_Encryption
- func (*Bucket_Encryption) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Encryption) GetCustomerManagedEncryptionEnforcementConfig() *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig
- func (x *Bucket_Encryption) GetCustomerSuppliedEncryptionEnforcementConfig() *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig
- func (x *Bucket_Encryption) GetDefaultKmsKey() string
- func (x *Bucket_Encryption) GetGoogleManagedEncryptionEnforcementConfig() *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig
- func (*Bucket_Encryption) ProtoMessage()
- func (x *Bucket_Encryption) ProtoReflect() protoreflect.Message
- func (x *Bucket_Encryption) Reset()
- func (x *Bucket_Encryption) String() string
- type Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig
- func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
- func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetRestrictionMode() string
- func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoMessage()
- func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
- func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Reset()
- func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) String() string
- type Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig
- func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
- func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetRestrictionMode() string
- func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoMessage()
- func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
- func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Reset()
- func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) String() string
- type Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig
- func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
- func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetRestrictionMode() string
- func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoMessage()
- func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
- func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Reset()
- func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) String() string
- type Bucket_HierarchicalNamespace
- func (*Bucket_HierarchicalNamespace) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_HierarchicalNamespace) GetEnabled() bool
- func (*Bucket_HierarchicalNamespace) ProtoMessage()
- func (x *Bucket_HierarchicalNamespace) ProtoReflect() protoreflect.Message
- func (x *Bucket_HierarchicalNamespace) Reset()
- func (x *Bucket_HierarchicalNamespace) String() string
- type Bucket_IamConfig
- func (*Bucket_IamConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_IamConfig) GetPublicAccessPrevention() string
- func (x *Bucket_IamConfig) GetUniformBucketLevelAccess() *Bucket_IamConfig_UniformBucketLevelAccess
- func (*Bucket_IamConfig) ProtoMessage()
- func (x *Bucket_IamConfig) ProtoReflect() protoreflect.Message
- func (x *Bucket_IamConfig) Reset()
- func (x *Bucket_IamConfig) String() string
- type Bucket_IamConfig_UniformBucketLevelAccess
- func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled() bool
- func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime() *timestamppb.Timestamp
- func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage()
- func (x *Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect() protoreflect.Message
- func (x *Bucket_IamConfig_UniformBucketLevelAccess) Reset()
- func (x *Bucket_IamConfig_UniformBucketLevelAccess) String() string
- type Bucket_IpFilter
- func (*Bucket_IpFilter) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_IpFilter) GetAllowAllServiceAgentAccess() bool
- func (x *Bucket_IpFilter) GetAllowCrossOrgVpcs() bool
- func (x *Bucket_IpFilter) GetMode() string
- func (x *Bucket_IpFilter) GetPublicNetworkSource() *Bucket_IpFilter_PublicNetworkSource
- func (x *Bucket_IpFilter) GetVpcNetworkSources() []*Bucket_IpFilter_VpcNetworkSource
- func (*Bucket_IpFilter) ProtoMessage()
- func (x *Bucket_IpFilter) ProtoReflect() protoreflect.Message
- func (x *Bucket_IpFilter) Reset()
- func (x *Bucket_IpFilter) String() string
- type Bucket_IpFilter_PublicNetworkSource
- func (*Bucket_IpFilter_PublicNetworkSource) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_IpFilter_PublicNetworkSource) GetAllowedIpCidrRanges() []string
- func (*Bucket_IpFilter_PublicNetworkSource) ProtoMessage()
- func (x *Bucket_IpFilter_PublicNetworkSource) ProtoReflect() protoreflect.Message
- func (x *Bucket_IpFilter_PublicNetworkSource) Reset()
- func (x *Bucket_IpFilter_PublicNetworkSource) String() string
- type Bucket_IpFilter_VpcNetworkSource
- func (*Bucket_IpFilter_VpcNetworkSource) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_IpFilter_VpcNetworkSource) GetAllowedIpCidrRanges() []string
- func (x *Bucket_IpFilter_VpcNetworkSource) GetNetwork() string
- func (*Bucket_IpFilter_VpcNetworkSource) ProtoMessage()
- func (x *Bucket_IpFilter_VpcNetworkSource) ProtoReflect() protoreflect.Message
- func (x *Bucket_IpFilter_VpcNetworkSource) Reset()
- func (x *Bucket_IpFilter_VpcNetworkSource) String() string
- type Bucket_Lifecycle
- func (*Bucket_Lifecycle) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Lifecycle) GetRule() []*Bucket_Lifecycle_Rule
- func (*Bucket_Lifecycle) ProtoMessage()
- func (x *Bucket_Lifecycle) ProtoReflect() protoreflect.Message
- func (x *Bucket_Lifecycle) Reset()
- func (x *Bucket_Lifecycle) String() string
- type Bucket_Lifecycle_Rule
- func (*Bucket_Lifecycle_Rule) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Lifecycle_Rule) GetAction() *Bucket_Lifecycle_Rule_Action
- func (x *Bucket_Lifecycle_Rule) GetCondition() *Bucket_Lifecycle_Rule_Condition
- func (*Bucket_Lifecycle_Rule) ProtoMessage()
- func (x *Bucket_Lifecycle_Rule) ProtoReflect() protoreflect.Message
- func (x *Bucket_Lifecycle_Rule) Reset()
- func (x *Bucket_Lifecycle_Rule) String() string
- type Bucket_Lifecycle_Rule_Action
- func (*Bucket_Lifecycle_Rule_Action) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Lifecycle_Rule_Action) GetStorageClass() string
- func (x *Bucket_Lifecycle_Rule_Action) GetType() string
- func (*Bucket_Lifecycle_Rule_Action) ProtoMessage()
- func (x *Bucket_Lifecycle_Rule_Action) ProtoReflect() protoreflect.Message
- func (x *Bucket_Lifecycle_Rule_Action) Reset()
- func (x *Bucket_Lifecycle_Rule_Action) String() string
- type Bucket_Lifecycle_Rule_Condition
- func (*Bucket_Lifecycle_Rule_Condition) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Lifecycle_Rule_Condition) GetAgeDays() int32
- func (x *Bucket_Lifecycle_Rule_Condition) GetCreatedBefore() *date.Date
- func (x *Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore() *date.Date
- func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime() int32
- func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime() int32
- func (x *Bucket_Lifecycle_Rule_Condition) GetIsLive() bool
- func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix() []string
- func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass() []string
- func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix() []string
- func (x *Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore() *date.Date
- func (x *Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions() int32
- func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage()
- func (x *Bucket_Lifecycle_Rule_Condition) ProtoReflect() protoreflect.Message
- func (x *Bucket_Lifecycle_Rule_Condition) Reset()
- func (x *Bucket_Lifecycle_Rule_Condition) String() string
- type Bucket_Logging
- func (*Bucket_Logging) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Logging) GetLogBucket() string
- func (x *Bucket_Logging) GetLogObjectPrefix() string
- func (*Bucket_Logging) ProtoMessage()
- func (x *Bucket_Logging) ProtoReflect() protoreflect.Message
- func (x *Bucket_Logging) Reset()
- func (x *Bucket_Logging) String() string
- type Bucket_ObjectRetention
- func (*Bucket_ObjectRetention) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_ObjectRetention) GetEnabled() bool
- func (*Bucket_ObjectRetention) ProtoMessage()
- func (x *Bucket_ObjectRetention) ProtoReflect() protoreflect.Message
- func (x *Bucket_ObjectRetention) Reset()
- func (x *Bucket_ObjectRetention) String() string
- type Bucket_RetentionPolicy
- func (*Bucket_RetentionPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_RetentionPolicy) GetEffectiveTime() *timestamppb.Timestamp
- func (x *Bucket_RetentionPolicy) GetIsLocked() bool
- func (x *Bucket_RetentionPolicy) GetRetentionDuration() *durationpb.Duration
- func (*Bucket_RetentionPolicy) ProtoMessage()
- func (x *Bucket_RetentionPolicy) ProtoReflect() protoreflect.Message
- func (x *Bucket_RetentionPolicy) Reset()
- func (x *Bucket_RetentionPolicy) String() string
- type Bucket_SoftDeletePolicy
- func (*Bucket_SoftDeletePolicy) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_SoftDeletePolicy) GetEffectiveTime() *timestamppb.Timestamp
- func (x *Bucket_SoftDeletePolicy) GetRetentionDuration() *durationpb.Duration
- func (*Bucket_SoftDeletePolicy) ProtoMessage()
- func (x *Bucket_SoftDeletePolicy) ProtoReflect() protoreflect.Message
- func (x *Bucket_SoftDeletePolicy) Reset()
- func (x *Bucket_SoftDeletePolicy) String() string
- type Bucket_Versioning
- type Bucket_Website
- func (*Bucket_Website) Descriptor() ([]byte, []int)deprecated
- func (x *Bucket_Website) GetMainPageSuffix() string
- func (x *Bucket_Website) GetNotFoundPage() string
- func (*Bucket_Website) ProtoMessage()
- func (x *Bucket_Website) ProtoReflect() protoreflect.Message
- func (x *Bucket_Website) Reset()
- func (x *Bucket_Website) String() string
- type CancelResumableWriteRequest
- func (*CancelResumableWriteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CancelResumableWriteRequest) GetUploadId() string
- func (*CancelResumableWriteRequest) ProtoMessage()
- func (x *CancelResumableWriteRequest) ProtoReflect() protoreflect.Message
- func (x *CancelResumableWriteRequest) Reset()
- func (x *CancelResumableWriteRequest) String() string
- type CancelResumableWriteResponse
- func (*CancelResumableWriteResponse) Descriptor() ([]byte, []int)deprecated
- func (*CancelResumableWriteResponse) ProtoMessage()
- func (x *CancelResumableWriteResponse) ProtoReflect() protoreflect.Message
- func (x *CancelResumableWriteResponse) Reset()
- func (x *CancelResumableWriteResponse) String() string
- type ChecksummedData
- func (*ChecksummedData) Descriptor() ([]byte, []int)deprecated
- func (x *ChecksummedData) GetContent() []byte
- func (x *ChecksummedData) GetCrc32C() uint32
- func (*ChecksummedData) ProtoMessage()
- func (x *ChecksummedData) ProtoReflect() protoreflect.Message
- func (x *ChecksummedData) Reset()
- func (x *ChecksummedData) String() string
- type CommonObjectRequestParams
- func (*CommonObjectRequestParams) Descriptor() ([]byte, []int)deprecated
- func (x *CommonObjectRequestParams) GetEncryptionAlgorithm() string
- func (x *CommonObjectRequestParams) GetEncryptionKeyBytes() []byte
- func (x *CommonObjectRequestParams) GetEncryptionKeySha256Bytes() []byte
- func (*CommonObjectRequestParams) ProtoMessage()
- func (x *CommonObjectRequestParams) ProtoReflect() protoreflect.Message
- func (x *CommonObjectRequestParams) Reset()
- func (x *CommonObjectRequestParams) String() string
- type ComposeObjectRequest
- func (*ComposeObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ComposeObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *ComposeObjectRequest) GetDestination() *Object
- func (x *ComposeObjectRequest) GetDestinationPredefinedAcl() string
- func (x *ComposeObjectRequest) GetIfGenerationMatch() int64
- func (x *ComposeObjectRequest) GetIfMetagenerationMatch() int64
- func (x *ComposeObjectRequest) GetKmsKey() string
- func (x *ComposeObjectRequest) GetObjectChecksums() *ObjectChecksums
- func (x *ComposeObjectRequest) GetSourceObjects() []*ComposeObjectRequest_SourceObject
- func (*ComposeObjectRequest) ProtoMessage()
- func (x *ComposeObjectRequest) ProtoReflect() protoreflect.Message
- func (x *ComposeObjectRequest) Reset()
- func (x *ComposeObjectRequest) String() string
- type ComposeObjectRequest_SourceObject
- func (*ComposeObjectRequest_SourceObject) Descriptor() ([]byte, []int)deprecated
- func (x *ComposeObjectRequest_SourceObject) GetGeneration() int64
- func (x *ComposeObjectRequest_SourceObject) GetName() string
- func (x *ComposeObjectRequest_SourceObject) GetObjectPreconditions() *ComposeObjectRequest_SourceObject_ObjectPreconditions
- func (*ComposeObjectRequest_SourceObject) ProtoMessage()
- func (x *ComposeObjectRequest_SourceObject) ProtoReflect() protoreflect.Message
- func (x *ComposeObjectRequest_SourceObject) Reset()
- func (x *ComposeObjectRequest_SourceObject) String() string
- type ComposeObjectRequest_SourceObject_ObjectPreconditions
- func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor() ([]byte, []int)deprecated
- func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch() int64
- func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage()
- func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect() protoreflect.Message
- func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset()
- func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) String() string
- type ContentRange
- func (*ContentRange) Descriptor() ([]byte, []int)deprecated
- func (x *ContentRange) GetCompleteLength() int64
- func (x *ContentRange) GetEnd() int64
- func (x *ContentRange) GetStart() int64
- func (*ContentRange) ProtoMessage()
- func (x *ContentRange) ProtoReflect() protoreflect.Message
- func (x *ContentRange) Reset()
- func (x *ContentRange) String() string
- type CreateBucketRequest
- func (*CreateBucketRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateBucketRequest) GetBucket() *Bucket
- func (x *CreateBucketRequest) GetBucketId() string
- func (x *CreateBucketRequest) GetEnableObjectRetention() bool
- func (x *CreateBucketRequest) GetParent() string
- func (x *CreateBucketRequest) GetPredefinedAcl() string
- func (x *CreateBucketRequest) GetPredefinedDefaultObjectAcl() string
- func (*CreateBucketRequest) ProtoMessage()
- func (x *CreateBucketRequest) ProtoReflect() protoreflect.Message
- func (x *CreateBucketRequest) Reset()
- func (x *CreateBucketRequest) String() string
- type CustomerEncryption
- func (*CustomerEncryption) Descriptor() ([]byte, []int)deprecated
- func (x *CustomerEncryption) GetEncryptionAlgorithm() string
- func (x *CustomerEncryption) GetKeySha256Bytes() []byte
- func (*CustomerEncryption) ProtoMessage()
- func (x *CustomerEncryption) ProtoReflect() protoreflect.Message
- func (x *CustomerEncryption) Reset()
- func (x *CustomerEncryption) String() string
- type DeleteBucketRequest
- func (*DeleteBucketRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteBucketRequest) GetIfMetagenerationMatch() int64
- func (x *DeleteBucketRequest) GetIfMetagenerationNotMatch() int64
- func (x *DeleteBucketRequest) GetName() string
- func (*DeleteBucketRequest) ProtoMessage()
- func (x *DeleteBucketRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteBucketRequest) Reset()
- func (x *DeleteBucketRequest) String() string
- type DeleteObjectRequest
- func (*DeleteObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteObjectRequest) GetBucket() string
- func (x *DeleteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *DeleteObjectRequest) GetGeneration() int64
- func (x *DeleteObjectRequest) GetIfGenerationMatch() int64
- func (x *DeleteObjectRequest) GetIfGenerationNotMatch() int64
- func (x *DeleteObjectRequest) GetIfMetagenerationMatch() int64
- func (x *DeleteObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *DeleteObjectRequest) GetObject() string
- func (*DeleteObjectRequest) ProtoMessage()
- func (x *DeleteObjectRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteObjectRequest) Reset()
- func (x *DeleteObjectRequest) String() string
- type GetBucketRequest
- func (*GetBucketRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetBucketRequest) GetIfMetagenerationMatch() int64
- func (x *GetBucketRequest) GetIfMetagenerationNotMatch() int64
- func (x *GetBucketRequest) GetName() string
- func (x *GetBucketRequest) GetReadMask() *fieldmaskpb.FieldMask
- func (*GetBucketRequest) ProtoMessage()
- func (x *GetBucketRequest) ProtoReflect() protoreflect.Message
- func (x *GetBucketRequest) Reset()
- func (x *GetBucketRequest) String() string
- type GetObjectRequest
- func (*GetObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetObjectRequest) GetBucket() string
- func (x *GetObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *GetObjectRequest) GetGeneration() int64
- func (x *GetObjectRequest) GetIfGenerationMatch() int64
- func (x *GetObjectRequest) GetIfGenerationNotMatch() int64
- func (x *GetObjectRequest) GetIfMetagenerationMatch() int64
- func (x *GetObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *GetObjectRequest) GetObject() string
- func (x *GetObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
- func (x *GetObjectRequest) GetRestoreToken() string
- func (x *GetObjectRequest) GetSoftDeleted() bool
- func (*GetObjectRequest) ProtoMessage()
- func (x *GetObjectRequest) ProtoReflect() protoreflect.Message
- func (x *GetObjectRequest) Reset()
- func (x *GetObjectRequest) String() string
- type ListBucketsRequest
- func (*ListBucketsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListBucketsRequest) GetPageSize() int32
- func (x *ListBucketsRequest) GetPageToken() string
- func (x *ListBucketsRequest) GetParent() string
- func (x *ListBucketsRequest) GetPrefix() string
- func (x *ListBucketsRequest) GetReadMask() *fieldmaskpb.FieldMask
- func (x *ListBucketsRequest) GetReturnPartialSuccess() bool
- func (*ListBucketsRequest) ProtoMessage()
- func (x *ListBucketsRequest) ProtoReflect() protoreflect.Message
- func (x *ListBucketsRequest) Reset()
- func (x *ListBucketsRequest) String() string
- type ListBucketsResponse
- func (*ListBucketsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListBucketsResponse) GetBuckets() []*Bucket
- func (x *ListBucketsResponse) GetNextPageToken() string
- func (x *ListBucketsResponse) GetUnreachable() []string
- func (*ListBucketsResponse) ProtoMessage()
- func (x *ListBucketsResponse) ProtoReflect() protoreflect.Message
- func (x *ListBucketsResponse) Reset()
- func (x *ListBucketsResponse) String() string
- type ListObjectsRequest
- func (*ListObjectsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListObjectsRequest) GetDelimiter() string
- func (x *ListObjectsRequest) GetFilter() string
- func (x *ListObjectsRequest) GetIncludeFoldersAsPrefixes() bool
- func (x *ListObjectsRequest) GetIncludeTrailingDelimiter() bool
- func (x *ListObjectsRequest) GetLexicographicEnd() string
- func (x *ListObjectsRequest) GetLexicographicStart() string
- func (x *ListObjectsRequest) GetMatchGlob() string
- func (x *ListObjectsRequest) GetPageSize() int32
- func (x *ListObjectsRequest) GetPageToken() string
- func (x *ListObjectsRequest) GetParent() string
- func (x *ListObjectsRequest) GetPrefix() string
- func (x *ListObjectsRequest) GetReadMask() *fieldmaskpb.FieldMask
- func (x *ListObjectsRequest) GetSoftDeleted() bool
- func (x *ListObjectsRequest) GetVersions() bool
- func (*ListObjectsRequest) ProtoMessage()
- func (x *ListObjectsRequest) ProtoReflect() protoreflect.Message
- func (x *ListObjectsRequest) Reset()
- func (x *ListObjectsRequest) String() string
- type ListObjectsResponse
- func (*ListObjectsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListObjectsResponse) GetNextPageToken() string
- func (x *ListObjectsResponse) GetObjects() []*Object
- func (x *ListObjectsResponse) GetPrefixes() []string
- func (*ListObjectsResponse) ProtoMessage()
- func (x *ListObjectsResponse) ProtoReflect() protoreflect.Message
- func (x *ListObjectsResponse) Reset()
- func (x *ListObjectsResponse) String() string
- type LockBucketRetentionPolicyRequest
- func (*LockBucketRetentionPolicyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *LockBucketRetentionPolicyRequest) GetBucket() string
- func (x *LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch() int64
- func (*LockBucketRetentionPolicyRequest) ProtoMessage()
- func (x *LockBucketRetentionPolicyRequest) ProtoReflect() protoreflect.Message
- func (x *LockBucketRetentionPolicyRequest) Reset()
- func (x *LockBucketRetentionPolicyRequest) String() string
- type MoveObjectRequest
- func (*MoveObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MoveObjectRequest) GetBucket() string
- func (x *MoveObjectRequest) GetDestinationObject() string
- func (x *MoveObjectRequest) GetIfGenerationMatch() int64
- func (x *MoveObjectRequest) GetIfGenerationNotMatch() int64
- func (x *MoveObjectRequest) GetIfMetagenerationMatch() int64
- func (x *MoveObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *MoveObjectRequest) GetIfSourceGenerationMatch() int64
- func (x *MoveObjectRequest) GetIfSourceGenerationNotMatch() int64
- func (x *MoveObjectRequest) GetIfSourceMetagenerationMatch() int64
- func (x *MoveObjectRequest) GetIfSourceMetagenerationNotMatch() int64
- func (x *MoveObjectRequest) GetSourceObject() string
- func (*MoveObjectRequest) ProtoMessage()
- func (x *MoveObjectRequest) ProtoReflect() protoreflect.Message
- func (x *MoveObjectRequest) Reset()
- func (x *MoveObjectRequest) String() string
- type Object
- func (*Object) Descriptor() ([]byte, []int)deprecated
- func (x *Object) GetAcl() []*ObjectAccessControl
- func (x *Object) GetBucket() string
- func (x *Object) GetCacheControl() string
- func (x *Object) GetChecksums() *ObjectChecksums
- func (x *Object) GetComponentCount() int32
- func (x *Object) GetContentDisposition() string
- func (x *Object) GetContentEncoding() string
- func (x *Object) GetContentLanguage() string
- func (x *Object) GetContentType() string
- func (x *Object) GetContexts() *ObjectContexts
- func (x *Object) GetCreateTime() *timestamppb.Timestamp
- func (x *Object) GetCustomTime() *timestamppb.Timestamp
- func (x *Object) GetCustomerEncryption() *CustomerEncryption
- func (x *Object) GetDeleteTime() *timestamppb.Timestamp
- func (x *Object) GetEtag() string
- func (x *Object) GetEventBasedHold() bool
- func (x *Object) GetFinalizeTime() *timestamppb.Timestamp
- func (x *Object) GetGeneration() int64
- func (x *Object) GetHardDeleteTime() *timestamppb.Timestamp
- func (x *Object) GetKmsKey() string
- func (x *Object) GetMetadata() map[string]string
- func (x *Object) GetMetageneration() int64
- func (x *Object) GetName() string
- func (x *Object) GetOwner() *Owner
- func (x *Object) GetRestoreToken() string
- func (x *Object) GetRetention() *Object_Retention
- func (x *Object) GetRetentionExpireTime() *timestamppb.Timestamp
- func (x *Object) GetSize() int64
- func (x *Object) GetSoftDeleteTime() *timestamppb.Timestamp
- func (x *Object) GetStorageClass() string
- func (x *Object) GetTemporaryHold() bool
- func (x *Object) GetUpdateStorageClassTime() *timestamppb.Timestamp
- func (x *Object) GetUpdateTime() *timestamppb.Timestamp
- func (*Object) ProtoMessage()
- func (x *Object) ProtoReflect() protoreflect.Message
- func (x *Object) Reset()
- func (x *Object) String() string
- type ObjectAccessControl
- func (*ObjectAccessControl) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectAccessControl) GetDomain() string
- func (x *ObjectAccessControl) GetEmail() string
- func (x *ObjectAccessControl) GetEntity() string
- func (x *ObjectAccessControl) GetEntityAlt() string
- func (x *ObjectAccessControl) GetEntityId() string
- func (x *ObjectAccessControl) GetEtag() string
- func (x *ObjectAccessControl) GetId() string
- func (x *ObjectAccessControl) GetProjectTeam() *ProjectTeam
- func (x *ObjectAccessControl) GetRole() string
- func (*ObjectAccessControl) ProtoMessage()
- func (x *ObjectAccessControl) ProtoReflect() protoreflect.Message
- func (x *ObjectAccessControl) Reset()
- func (x *ObjectAccessControl) String() string
- type ObjectChecksums
- func (*ObjectChecksums) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectChecksums) GetCrc32C() uint32
- func (x *ObjectChecksums) GetMd5Hash() []byte
- func (*ObjectChecksums) ProtoMessage()
- func (x *ObjectChecksums) ProtoReflect() protoreflect.Message
- func (x *ObjectChecksums) Reset()
- func (x *ObjectChecksums) String() string
- type ObjectContexts
- func (*ObjectContexts) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectContexts) GetCustom() map[string]*ObjectCustomContextPayload
- func (*ObjectContexts) ProtoMessage()
- func (x *ObjectContexts) ProtoReflect() protoreflect.Message
- func (x *ObjectContexts) Reset()
- func (x *ObjectContexts) String() string
- type ObjectCustomContextPayload
- func (*ObjectCustomContextPayload) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectCustomContextPayload) GetCreateTime() *timestamppb.Timestamp
- func (x *ObjectCustomContextPayload) GetUpdateTime() *timestamppb.Timestamp
- func (x *ObjectCustomContextPayload) GetValue() string
- func (*ObjectCustomContextPayload) ProtoMessage()
- func (x *ObjectCustomContextPayload) ProtoReflect() protoreflect.Message
- func (x *ObjectCustomContextPayload) Reset()
- func (x *ObjectCustomContextPayload) String() string
- type ObjectRangeData
- func (*ObjectRangeData) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectRangeData) GetChecksummedData() *ChecksummedData
- func (x *ObjectRangeData) GetRangeEnd() bool
- func (x *ObjectRangeData) GetReadRange() *ReadRange
- func (*ObjectRangeData) ProtoMessage()
- func (x *ObjectRangeData) ProtoReflect() protoreflect.Message
- func (x *ObjectRangeData) Reset()
- func (x *ObjectRangeData) String() string
- type Object_Retention
- func (*Object_Retention) Descriptor() ([]byte, []int)deprecated
- func (x *Object_Retention) GetMode() Object_Retention_Mode
- func (x *Object_Retention) GetRetainUntilTime() *timestamppb.Timestamp
- func (*Object_Retention) ProtoMessage()
- func (x *Object_Retention) ProtoReflect() protoreflect.Message
- func (x *Object_Retention) Reset()
- func (x *Object_Retention) String() string
- type Object_Retention_Mode
- func (Object_Retention_Mode) Descriptor() protoreflect.EnumDescriptor
- func (x Object_Retention_Mode) Enum() *Object_Retention_Mode
- func (Object_Retention_Mode) EnumDescriptor() ([]byte, []int)deprecated
- func (x Object_Retention_Mode) Number() protoreflect.EnumNumber
- func (x Object_Retention_Mode) String() string
- func (Object_Retention_Mode) Type() protoreflect.EnumType
- type Owner
- type ProjectTeam
- func (*ProjectTeam) Descriptor() ([]byte, []int)deprecated
- func (x *ProjectTeam) GetProjectNumber() string
- func (x *ProjectTeam) GetTeam() string
- func (*ProjectTeam) ProtoMessage()
- func (x *ProjectTeam) ProtoReflect() protoreflect.Message
- func (x *ProjectTeam) Reset()
- func (x *ProjectTeam) String() string
- type QueryWriteStatusRequest
- func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryWriteStatusRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *QueryWriteStatusRequest) GetUploadId() string
- func (*QueryWriteStatusRequest) ProtoMessage()
- func (x *QueryWriteStatusRequest) ProtoReflect() protoreflect.Message
- func (x *QueryWriteStatusRequest) Reset()
- func (x *QueryWriteStatusRequest) String() string
- type QueryWriteStatusResponse
- func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)deprecated
- func (x *QueryWriteStatusResponse) GetPersistedSize() int64
- func (x *QueryWriteStatusResponse) GetResource() *Object
- func (m *QueryWriteStatusResponse) GetWriteStatus() isQueryWriteStatusResponse_WriteStatus
- func (*QueryWriteStatusResponse) ProtoMessage()
- func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message
- func (x *QueryWriteStatusResponse) Reset()
- func (x *QueryWriteStatusResponse) String() string
- type QueryWriteStatusResponse_PersistedSize
- type QueryWriteStatusResponse_Resource
- type ReadObjectRequest
- func (*ReadObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ReadObjectRequest) GetBucket() string
- func (x *ReadObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *ReadObjectRequest) GetGeneration() int64
- func (x *ReadObjectRequest) GetIfGenerationMatch() int64
- func (x *ReadObjectRequest) GetIfGenerationNotMatch() int64
- func (x *ReadObjectRequest) GetIfMetagenerationMatch() int64
- func (x *ReadObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *ReadObjectRequest) GetObject() string
- func (x *ReadObjectRequest) GetReadLimit() int64
- func (x *ReadObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
- func (x *ReadObjectRequest) GetReadOffset() int64
- func (*ReadObjectRequest) ProtoMessage()
- func (x *ReadObjectRequest) ProtoReflect() protoreflect.Message
- func (x *ReadObjectRequest) Reset()
- func (x *ReadObjectRequest) String() string
- type ReadObjectResponse
- func (*ReadObjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ReadObjectResponse) GetChecksummedData() *ChecksummedData
- func (x *ReadObjectResponse) GetContentRange() *ContentRange
- func (x *ReadObjectResponse) GetMetadata() *Object
- func (x *ReadObjectResponse) GetObjectChecksums() *ObjectChecksums
- func (*ReadObjectResponse) ProtoMessage()
- func (x *ReadObjectResponse) ProtoReflect() protoreflect.Message
- func (x *ReadObjectResponse) Reset()
- func (x *ReadObjectResponse) String() string
- type ReadRange
- func (*ReadRange) Descriptor() ([]byte, []int)deprecated
- func (x *ReadRange) GetReadId() int64
- func (x *ReadRange) GetReadLength() int64
- func (x *ReadRange) GetReadOffset() int64
- func (*ReadRange) ProtoMessage()
- func (x *ReadRange) ProtoReflect() protoreflect.Message
- func (x *ReadRange) Reset()
- func (x *ReadRange) String() string
- type ReadRangeError
- func (*ReadRangeError) Descriptor() ([]byte, []int)deprecated
- func (x *ReadRangeError) GetReadId() int64
- func (x *ReadRangeError) GetStatus() *status.Status
- func (*ReadRangeError) ProtoMessage()
- func (x *ReadRangeError) ProtoReflect() protoreflect.Message
- func (x *ReadRangeError) Reset()
- func (x *ReadRangeError) String() string
- type RestoreObjectRequest
- func (*RestoreObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RestoreObjectRequest) GetBucket() string
- func (x *RestoreObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *RestoreObjectRequest) GetCopySourceAcl() bool
- func (x *RestoreObjectRequest) GetGeneration() int64
- func (x *RestoreObjectRequest) GetIfGenerationMatch() int64
- func (x *RestoreObjectRequest) GetIfGenerationNotMatch() int64
- func (x *RestoreObjectRequest) GetIfMetagenerationMatch() int64
- func (x *RestoreObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *RestoreObjectRequest) GetObject() string
- func (x *RestoreObjectRequest) GetRestoreToken() string
- func (*RestoreObjectRequest) ProtoMessage()
- func (x *RestoreObjectRequest) ProtoReflect() protoreflect.Message
- func (x *RestoreObjectRequest) Reset()
- func (x *RestoreObjectRequest) String() string
- type RewriteObjectRequest
- func (*RewriteObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RewriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *RewriteObjectRequest) GetCopySourceEncryptionAlgorithm() string
- func (x *RewriteObjectRequest) GetCopySourceEncryptionKeyBytes() []byte
- func (x *RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes() []byte
- func (x *RewriteObjectRequest) GetDestination() *Object
- func (x *RewriteObjectRequest) GetDestinationBucket() string
- func (x *RewriteObjectRequest) GetDestinationKmsKey() string
- func (x *RewriteObjectRequest) GetDestinationName() string
- func (x *RewriteObjectRequest) GetDestinationPredefinedAcl() string
- func (x *RewriteObjectRequest) GetIfGenerationMatch() int64
- func (x *RewriteObjectRequest) GetIfGenerationNotMatch() int64
- func (x *RewriteObjectRequest) GetIfMetagenerationMatch() int64
- func (x *RewriteObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *RewriteObjectRequest) GetIfSourceGenerationMatch() int64
- func (x *RewriteObjectRequest) GetIfSourceGenerationNotMatch() int64
- func (x *RewriteObjectRequest) GetIfSourceMetagenerationMatch() int64
- func (x *RewriteObjectRequest) GetIfSourceMetagenerationNotMatch() int64
- func (x *RewriteObjectRequest) GetMaxBytesRewrittenPerCall() int64
- func (x *RewriteObjectRequest) GetObjectChecksums() *ObjectChecksums
- func (x *RewriteObjectRequest) GetRewriteToken() string
- func (x *RewriteObjectRequest) GetSourceBucket() string
- func (x *RewriteObjectRequest) GetSourceGeneration() int64
- func (x *RewriteObjectRequest) GetSourceObject() string
- func (*RewriteObjectRequest) ProtoMessage()
- func (x *RewriteObjectRequest) ProtoReflect() protoreflect.Message
- func (x *RewriteObjectRequest) Reset()
- func (x *RewriteObjectRequest) String() string
- type RewriteResponse
- func (*RewriteResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RewriteResponse) GetDone() bool
- func (x *RewriteResponse) GetObjectSize() int64
- func (x *RewriteResponse) GetResource() *Object
- func (x *RewriteResponse) GetRewriteToken() string
- func (x *RewriteResponse) GetTotalBytesRewritten() int64
- func (*RewriteResponse) ProtoMessage()
- func (x *RewriteResponse) ProtoReflect() protoreflect.Message
- func (x *RewriteResponse) Reset()
- func (x *RewriteResponse) String() string
- type ServiceConstants
- type ServiceConstants_Values
- func (ServiceConstants_Values) Descriptor() protoreflect.EnumDescriptor
- func (x ServiceConstants_Values) Enum() *ServiceConstants_Values
- func (ServiceConstants_Values) EnumDescriptor() ([]byte, []int)deprecated
- func (x ServiceConstants_Values) Number() protoreflect.EnumNumber
- func (x ServiceConstants_Values) String() string
- func (ServiceConstants_Values) Type() protoreflect.EnumType
- type StartResumableWriteRequest
- func (*StartResumableWriteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StartResumableWriteRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *StartResumableWriteRequest) GetObjectChecksums() *ObjectChecksums
- func (x *StartResumableWriteRequest) GetWriteObjectSpec() *WriteObjectSpec
- func (*StartResumableWriteRequest) ProtoMessage()
- func (x *StartResumableWriteRequest) ProtoReflect() protoreflect.Message
- func (x *StartResumableWriteRequest) Reset()
- func (x *StartResumableWriteRequest) String() string
- type StartResumableWriteResponse
- func (*StartResumableWriteResponse) Descriptor() ([]byte, []int)deprecated
- func (x *StartResumableWriteResponse) GetUploadId() string
- func (*StartResumableWriteResponse) ProtoMessage()
- func (x *StartResumableWriteResponse) ProtoReflect() protoreflect.Message
- func (x *StartResumableWriteResponse) Reset()
- func (x *StartResumableWriteResponse) String() string
- type StorageClient
- type StorageServer
- type Storage_BidiReadObjectClient
- type Storage_BidiReadObjectServer
- type Storage_BidiWriteObjectClient
- type Storage_BidiWriteObjectServer
- type Storage_ReadObjectClient
- type Storage_ReadObjectServer
- type Storage_WriteObjectClient
- type Storage_WriteObjectServer
- type UnimplementedStorageServer
- func (UnimplementedStorageServer) BidiReadObject(Storage_BidiReadObjectServer) error
- func (UnimplementedStorageServer) BidiWriteObject(Storage_BidiWriteObjectServer) error
- func (UnimplementedStorageServer) CancelResumableWrite(context.Context, *CancelResumableWriteRequest) (*CancelResumableWriteResponse, error)
- func (UnimplementedStorageServer) ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
- func (UnimplementedStorageServer) CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)
- func (UnimplementedStorageServer) DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
- func (UnimplementedStorageServer) DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)
- func (UnimplementedStorageServer) GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
- func (UnimplementedStorageServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
- func (UnimplementedStorageServer) GetObject(context.Context, *GetObjectRequest) (*Object, error)
- func (UnimplementedStorageServer) ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
- func (UnimplementedStorageServer) ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
- func (UnimplementedStorageServer) LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)
- func (UnimplementedStorageServer) MoveObject(context.Context, *MoveObjectRequest) (*Object, error)
- func (UnimplementedStorageServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
- func (UnimplementedStorageServer) ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error
- func (UnimplementedStorageServer) RestoreObject(context.Context, *RestoreObjectRequest) (*Object, error)
- func (UnimplementedStorageServer) RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
- func (UnimplementedStorageServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
- func (UnimplementedStorageServer) StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
- func (UnimplementedStorageServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
- func (UnimplementedStorageServer) UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
- func (UnimplementedStorageServer) UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
- func (UnimplementedStorageServer) WriteObject(Storage_WriteObjectServer) error
- type UnsafeStorageServer
- type UpdateBucketRequest
- func (*UpdateBucketRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateBucketRequest) GetBucket() *Bucket
- func (x *UpdateBucketRequest) GetIfMetagenerationMatch() int64
- func (x *UpdateBucketRequest) GetIfMetagenerationNotMatch() int64
- func (x *UpdateBucketRequest) GetPredefinedAcl() string
- func (x *UpdateBucketRequest) GetPredefinedDefaultObjectAcl() string
- func (x *UpdateBucketRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (*UpdateBucketRequest) ProtoMessage()
- func (x *UpdateBucketRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateBucketRequest) Reset()
- func (x *UpdateBucketRequest) String() string
- type UpdateObjectRequest
- func (*UpdateObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (x *UpdateObjectRequest) GetIfGenerationMatch() int64
- func (x *UpdateObjectRequest) GetIfGenerationNotMatch() int64
- func (x *UpdateObjectRequest) GetIfMetagenerationMatch() int64
- func (x *UpdateObjectRequest) GetIfMetagenerationNotMatch() int64
- func (x *UpdateObjectRequest) GetObject() *Object
- func (x *UpdateObjectRequest) GetOverrideUnlockedRetention() bool
- func (x *UpdateObjectRequest) GetPredefinedAcl() string
- func (x *UpdateObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (*UpdateObjectRequest) ProtoMessage()
- func (x *UpdateObjectRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateObjectRequest) Reset()
- func (x *UpdateObjectRequest) String() string
- type WriteObjectRequest
- func (*WriteObjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WriteObjectRequest) GetChecksummedData() *ChecksummedData
- func (x *WriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
- func (m *WriteObjectRequest) GetData() isWriteObjectRequest_Data
- func (x *WriteObjectRequest) GetFinishWrite() bool
- func (m *WriteObjectRequest) GetFirstMessage() isWriteObjectRequest_FirstMessage
- func (x *WriteObjectRequest) GetObjectChecksums() *ObjectChecksums
- func (x *WriteObjectRequest) GetUploadId() string
- func (x *WriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec
- func (x *WriteObjectRequest) GetWriteOffset() int64
- func (*WriteObjectRequest) ProtoMessage()
- func (x *WriteObjectRequest) ProtoReflect() protoreflect.Message
- func (x *WriteObjectRequest) Reset()
- func (x *WriteObjectRequest) String() string
- type WriteObjectRequest_ChecksummedData
- type WriteObjectRequest_UploadId
- type WriteObjectRequest_WriteObjectSpec
- type WriteObjectResponse
- func (*WriteObjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *WriteObjectResponse) GetPersistedSize() int64
- func (x *WriteObjectResponse) GetResource() *Object
- func (m *WriteObjectResponse) GetWriteStatus() isWriteObjectResponse_WriteStatus
- func (*WriteObjectResponse) ProtoMessage()
- func (x *WriteObjectResponse) ProtoReflect() protoreflect.Message
- func (x *WriteObjectResponse) Reset()
- func (x *WriteObjectResponse) String() string
- type WriteObjectResponse_PersistedSize
- type WriteObjectResponse_Resource
- type WriteObjectSpec
- func (*WriteObjectSpec) Descriptor() ([]byte, []int)deprecated
- func (x *WriteObjectSpec) GetAppendable() bool
- func (x *WriteObjectSpec) GetIfGenerationMatch() int64
- func (x *WriteObjectSpec) GetIfGenerationNotMatch() int64
- func (x *WriteObjectSpec) GetIfMetagenerationMatch() int64
- func (x *WriteObjectSpec) GetIfMetagenerationNotMatch() int64
- func (x *WriteObjectSpec) GetObjectSize() int64
- func (x *WriteObjectSpec) GetPredefinedAcl() string
- func (x *WriteObjectSpec) GetResource() *Object
- func (*WriteObjectSpec) ProtoMessage()
- func (x *WriteObjectSpec) ProtoReflect() protoreflect.Message
- func (x *WriteObjectSpec) Reset()
- func (x *WriteObjectSpec) String() string
Constants ¶
const ( Storage_DeleteBucket_FullMethodName = "/google.storage.v2.Storage/DeleteBucket" Storage_GetBucket_FullMethodName = "/google.storage.v2.Storage/GetBucket" Storage_CreateBucket_FullMethodName = "/google.storage.v2.Storage/CreateBucket" Storage_ListBuckets_FullMethodName = "/google.storage.v2.Storage/ListBuckets" Storage_LockBucketRetentionPolicy_FullMethodName = "/google.storage.v2.Storage/LockBucketRetentionPolicy" Storage_GetIamPolicy_FullMethodName = "/google.storage.v2.Storage/GetIamPolicy" Storage_SetIamPolicy_FullMethodName = "/google.storage.v2.Storage/SetIamPolicy" Storage_TestIamPermissions_FullMethodName = "/google.storage.v2.Storage/TestIamPermissions" Storage_UpdateBucket_FullMethodName = "/google.storage.v2.Storage/UpdateBucket" Storage_ComposeObject_FullMethodName = "/google.storage.v2.Storage/ComposeObject" Storage_DeleteObject_FullMethodName = "/google.storage.v2.Storage/DeleteObject" Storage_RestoreObject_FullMethodName = "/google.storage.v2.Storage/RestoreObject" Storage_CancelResumableWrite_FullMethodName = "/google.storage.v2.Storage/CancelResumableWrite" Storage_GetObject_FullMethodName = "/google.storage.v2.Storage/GetObject" Storage_ReadObject_FullMethodName = "/google.storage.v2.Storage/ReadObject" Storage_BidiReadObject_FullMethodName = "/google.storage.v2.Storage/BidiReadObject" Storage_UpdateObject_FullMethodName = "/google.storage.v2.Storage/UpdateObject" Storage_WriteObject_FullMethodName = "/google.storage.v2.Storage/WriteObject" Storage_BidiWriteObject_FullMethodName = "/google.storage.v2.Storage/BidiWriteObject" Storage_ListObjects_FullMethodName = "/google.storage.v2.Storage/ListObjects" Storage_RewriteObject_FullMethodName = "/google.storage.v2.Storage/RewriteObject" Storage_StartResumableWrite_FullMethodName = "/google.storage.v2.Storage/StartResumableWrite" Storage_QueryWriteStatus_FullMethodName = "/google.storage.v2.Storage/QueryWriteStatus" Storage_MoveObject_FullMethodName = "/google.storage.v2.Storage/MoveObject" )
Variables ¶
var ( ServiceConstants_Values_name = map[int32]string{ 0: "VALUES_UNSPECIFIED", 2097152: "MAX_READ_CHUNK_BYTES", 5242880: "MAX_OBJECT_SIZE_MB", 1024: "MAX_CUSTOM_METADATA_FIELD_NAME_BYTES", 4096: "MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES", 8192: "MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES", 20480: "MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES", 100: "MAX_NOTIFICATION_CONFIGS_PER_BUCKET", 5: "MAX_NOTIFICATION_CUSTOM_ATTRIBUTES", 256: "MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH", 64: "MAX_LABELS_ENTRIES_COUNT", 63: "MAX_LABELS_KEY_VALUE_LENGTH", 128: "MAX_LABELS_KEY_VALUE_BYTES", 1000: "MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST", 14: "SPLIT_TOKEN_MAX_VALID_DAYS", } ServiceConstants_Values_value = map[string]int32{ "VALUES_UNSPECIFIED": 0, "MAX_READ_CHUNK_BYTES": 2097152, "MAX_WRITE_CHUNK_BYTES": 2097152, "MAX_OBJECT_SIZE_MB": 5242880, "MAX_CUSTOM_METADATA_FIELD_NAME_BYTES": 1024, "MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES": 4096, "MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES": 8192, "MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES": 20480, "MAX_NOTIFICATION_CONFIGS_PER_BUCKET": 100, "MAX_LIFECYCLE_RULES_PER_BUCKET": 100, "MAX_NOTIFICATION_CUSTOM_ATTRIBUTES": 5, "MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH": 256, "MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_VALUE_LENGTH": 1024, "MAX_LABELS_ENTRIES_COUNT": 64, "MAX_LABELS_KEY_VALUE_LENGTH": 63, "MAX_LABELS_KEY_VALUE_BYTES": 128, "MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST": 1000, "SPLIT_TOKEN_MAX_VALID_DAYS": 14, } )
Enum value maps for ServiceConstants_Values.
var ( Object_Retention_Mode_name = map[int32]string{ 0: "MODE_UNSPECIFIED", 1: "UNLOCKED", 2: "LOCKED", } Object_Retention_Mode_value = map[string]int32{ "MODE_UNSPECIFIED": 0, "UNLOCKED": 1, "LOCKED": 2, } )
Enum value maps for Object_Retention_Mode.
var File_google_storage_v2_storage_proto protoreflect.FileDescriptor
var Storage_ServiceDesc = grpc.ServiceDesc{ ServiceName: "google.storage.v2.Storage", HandlerType: (*StorageServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "DeleteBucket", Handler: _Storage_DeleteBucket_Handler, }, { MethodName: "GetBucket", Handler: _Storage_GetBucket_Handler, }, { MethodName: "CreateBucket", Handler: _Storage_CreateBucket_Handler, }, { MethodName: "ListBuckets", Handler: _Storage_ListBuckets_Handler, }, { MethodName: "LockBucketRetentionPolicy", Handler: _Storage_LockBucketRetentionPolicy_Handler, }, { MethodName: "GetIamPolicy", Handler: _Storage_GetIamPolicy_Handler, }, { MethodName: "SetIamPolicy", Handler: _Storage_SetIamPolicy_Handler, }, { MethodName: "TestIamPermissions", Handler: _Storage_TestIamPermissions_Handler, }, { MethodName: "UpdateBucket", Handler: _Storage_UpdateBucket_Handler, }, { MethodName: "ComposeObject", Handler: _Storage_ComposeObject_Handler, }, { MethodName: "DeleteObject", Handler: _Storage_DeleteObject_Handler, }, { MethodName: "RestoreObject", Handler: _Storage_RestoreObject_Handler, }, { MethodName: "CancelResumableWrite", Handler: _Storage_CancelResumableWrite_Handler, }, { MethodName: "GetObject", Handler: _Storage_GetObject_Handler, }, { MethodName: "UpdateObject", Handler: _Storage_UpdateObject_Handler, }, { MethodName: "ListObjects", Handler: _Storage_ListObjects_Handler, }, { MethodName: "RewriteObject", Handler: _Storage_RewriteObject_Handler, }, { MethodName: "StartResumableWrite", Handler: _Storage_StartResumableWrite_Handler, }, { MethodName: "QueryWriteStatus", Handler: _Storage_QueryWriteStatus_Handler, }, { MethodName: "MoveObject", Handler: _Storage_MoveObject_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "ReadObject", Handler: _Storage_ReadObject_Handler, ServerStreams: true, }, { StreamName: "BidiReadObject", Handler: _Storage_BidiReadObject_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "WriteObject", Handler: _Storage_WriteObject_Handler, ClientStreams: true, }, { StreamName: "BidiWriteObject", Handler: _Storage_BidiWriteObject_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "google/storage/v2/storage.proto", }
Storage_ServiceDesc is the grpc.ServiceDesc for Storage service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterStorageServer ¶
func RegisterStorageServer(s grpc.ServiceRegistrar, srv StorageServer)
Types ¶
type AppendObjectSpec ¶ added in v1.50.0
type AppendObjectSpec struct {
// Required. The name of the bucket containing the object to write.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The name of the object to open for writing.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Required. The generation number of the object to open for writing.
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
//
// Note that metageneration preconditions are only checked if `write_handle`
// is empty.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
//
// Note that metageneration preconditions are only checked if `write_handle`
// is empty.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// An optional routing token that influences request routing for the stream.
// Must be provided if a `BidiWriteObjectRedirectedError` is returned.
RoutingToken *string `protobuf:"bytes,6,opt,name=routing_token,json=routingToken,proto3,oneof" json:"routing_token,omitempty"`
// An optional write handle returned from a previous BidiWriteObjectResponse
// message or a BidiWriteObjectRedirectedError error.
//
// Note that metageneration preconditions are only checked if `write_handle`
// is empty.
WriteHandle *BidiWriteHandle `protobuf:"bytes,7,opt,name=write_handle,json=writeHandle,proto3,oneof" json:"write_handle,omitempty"`
// contains filtered or unexported fields
}
Describes an attempt to append to an object, possibly over multiple requests.
func (*AppendObjectSpec) Descriptor
deprecated
added in
v1.50.0
func (*AppendObjectSpec) Descriptor() ([]byte, []int)
Deprecated: Use AppendObjectSpec.ProtoReflect.Descriptor instead.
func (*AppendObjectSpec) GetBucket ¶ added in v1.50.0
func (x *AppendObjectSpec) GetBucket() string
func (*AppendObjectSpec) GetGeneration ¶ added in v1.50.0
func (x *AppendObjectSpec) GetGeneration() int64
func (*AppendObjectSpec) GetIfMetagenerationMatch ¶ added in v1.50.0
func (x *AppendObjectSpec) GetIfMetagenerationMatch() int64
func (*AppendObjectSpec) GetIfMetagenerationNotMatch ¶ added in v1.50.0
func (x *AppendObjectSpec) GetIfMetagenerationNotMatch() int64
func (*AppendObjectSpec) GetObject ¶ added in v1.50.0
func (x *AppendObjectSpec) GetObject() string
func (*AppendObjectSpec) GetRoutingToken ¶ added in v1.50.0
func (x *AppendObjectSpec) GetRoutingToken() string
func (*AppendObjectSpec) GetWriteHandle ¶ added in v1.50.0
func (x *AppendObjectSpec) GetWriteHandle() *BidiWriteHandle
func (*AppendObjectSpec) ProtoMessage ¶ added in v1.50.0
func (*AppendObjectSpec) ProtoMessage()
func (*AppendObjectSpec) ProtoReflect ¶ added in v1.50.0
func (x *AppendObjectSpec) ProtoReflect() protoreflect.Message
func (*AppendObjectSpec) Reset ¶ added in v1.50.0
func (x *AppendObjectSpec) Reset()
func (*AppendObjectSpec) String ¶ added in v1.50.0
func (x *AppendObjectSpec) String() string
type BidiReadHandle ¶ added in v1.50.0
type BidiReadHandle struct {
// Required. Opaque value describing a previous read.
Handle []byte `protobuf:"bytes,1,opt,name=handle,proto3" json:"handle,omitempty"`
// contains filtered or unexported fields
}
`BidiReadHandle` contains a handle from a previous `BiDiReadObject` invocation. The client can use this instead of `BidiReadObjectSpec` as an optimized way of opening subsequent bidirectional streams to the same object.
func (*BidiReadHandle) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadHandle) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadHandle.ProtoReflect.Descriptor instead.
func (*BidiReadHandle) GetHandle ¶ added in v1.50.0
func (x *BidiReadHandle) GetHandle() []byte
func (*BidiReadHandle) ProtoMessage ¶ added in v1.50.0
func (*BidiReadHandle) ProtoMessage()
func (*BidiReadHandle) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadHandle) ProtoReflect() protoreflect.Message
func (*BidiReadHandle) Reset ¶ added in v1.50.0
func (x *BidiReadHandle) Reset()
func (*BidiReadHandle) String ¶ added in v1.50.0
func (x *BidiReadHandle) String() string
type BidiReadObjectError ¶ added in v1.50.0
type BidiReadObjectError struct {
// The error code for each outstanding read_range
ReadRangeErrors []*ReadRangeError `protobuf:"bytes,1,rep,name=read_range_errors,json=readRangeErrors,proto3" json:"read_range_errors,omitempty"`
// contains filtered or unexported fields
}
Error extension proto containing details for all outstanding reads on the failed stream
func (*BidiReadObjectError) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadObjectError) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadObjectError.ProtoReflect.Descriptor instead.
func (*BidiReadObjectError) GetReadRangeErrors ¶ added in v1.50.0
func (x *BidiReadObjectError) GetReadRangeErrors() []*ReadRangeError
func (*BidiReadObjectError) ProtoMessage ¶ added in v1.50.0
func (*BidiReadObjectError) ProtoMessage()
func (*BidiReadObjectError) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadObjectError) ProtoReflect() protoreflect.Message
func (*BidiReadObjectError) Reset ¶ added in v1.50.0
func (x *BidiReadObjectError) Reset()
func (*BidiReadObjectError) String ¶ added in v1.50.0
func (x *BidiReadObjectError) String() string
type BidiReadObjectRedirectedError ¶ added in v1.50.0
type BidiReadObjectRedirectedError struct {
// The read handle for the redirected read. If set, the client might use this
// in the BidiReadObjectSpec when retrying the read stream.
ReadHandle *BidiReadHandle `protobuf:"bytes,1,opt,name=read_handle,json=readHandle,proto3" json:"read_handle,omitempty"`
// The routing token the client must use when retrying the read stream.
// This value must be provided in the header `x-goog-request-params`, with key
// `routing_token` and this string verbatim as the value.
RoutingToken *string `protobuf:"bytes,2,opt,name=routing_token,json=routingToken,proto3,oneof" json:"routing_token,omitempty"`
// contains filtered or unexported fields
}
Error proto containing details for a redirected read. This error might be attached as details for an ABORTED response to BidiReadObject.
func (*BidiReadObjectRedirectedError) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadObjectRedirectedError) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadObjectRedirectedError.ProtoReflect.Descriptor instead.
func (*BidiReadObjectRedirectedError) GetReadHandle ¶ added in v1.50.0
func (x *BidiReadObjectRedirectedError) GetReadHandle() *BidiReadHandle
func (*BidiReadObjectRedirectedError) GetRoutingToken ¶ added in v1.50.0
func (x *BidiReadObjectRedirectedError) GetRoutingToken() string
func (*BidiReadObjectRedirectedError) ProtoMessage ¶ added in v1.50.0
func (*BidiReadObjectRedirectedError) ProtoMessage()
func (*BidiReadObjectRedirectedError) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadObjectRedirectedError) ProtoReflect() protoreflect.Message
func (*BidiReadObjectRedirectedError) Reset ¶ added in v1.50.0
func (x *BidiReadObjectRedirectedError) Reset()
func (*BidiReadObjectRedirectedError) String ¶ added in v1.50.0
func (x *BidiReadObjectRedirectedError) String() string
type BidiReadObjectRequest ¶ added in v1.50.0
type BidiReadObjectRequest struct {
// Optional. The first message of each stream should set this field. If this
// is not the first message, an error is returned. Describes the object to
// read.
ReadObjectSpec *BidiReadObjectSpec `protobuf:"bytes,1,opt,name=read_object_spec,json=readObjectSpec,proto3" json:"read_object_spec,omitempty"`
// Optional. Provides a list of 0 or more (up to 100) ranges to read. If a
// single range is large enough to require multiple responses, they are
// delivered in increasing offset order. There are no ordering guarantees
// across ranges. When no ranges are provided, the response message
// doesn't include `ObjectRangeData`. For full object downloads, the
// offset and size can be set to `0`.
ReadRanges []*ReadRange `protobuf:"bytes,8,rep,name=read_ranges,json=readRanges,proto3" json:"read_ranges,omitempty"`
// contains filtered or unexported fields
}
Request message for [BidiReadObject][google.storage.v2.Storage.BidiReadObject].
func (*BidiReadObjectRequest) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadObjectRequest.ProtoReflect.Descriptor instead.
func (*BidiReadObjectRequest) GetReadObjectSpec ¶ added in v1.50.0
func (x *BidiReadObjectRequest) GetReadObjectSpec() *BidiReadObjectSpec
func (*BidiReadObjectRequest) GetReadRanges ¶ added in v1.50.0
func (x *BidiReadObjectRequest) GetReadRanges() []*ReadRange
func (*BidiReadObjectRequest) ProtoMessage ¶ added in v1.50.0
func (*BidiReadObjectRequest) ProtoMessage()
func (*BidiReadObjectRequest) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadObjectRequest) ProtoReflect() protoreflect.Message
func (*BidiReadObjectRequest) Reset ¶ added in v1.50.0
func (x *BidiReadObjectRequest) Reset()
func (*BidiReadObjectRequest) String ¶ added in v1.50.0
func (x *BidiReadObjectRequest) String() string
type BidiReadObjectResponse ¶ added in v1.50.0
type BidiReadObjectResponse struct {
// A portion of the object's data. The service might leave data
// empty for any given `ReadResponse`. This enables the service to inform the
// client that the request is still live while it is running an operation to
// generate more data.
// The service might pipeline multiple responses belonging to different read
// requests. Each `ObjectRangeData` entry has a `read_id` that is set
// to the same value as the corresponding source read request.
ObjectDataRanges []*ObjectRangeData `protobuf:"bytes,6,rep,name=object_data_ranges,json=objectDataRanges,proto3" json:"object_data_ranges,omitempty"`
// Metadata of the object whose media is being returned.
// Only populated in the first response in the stream and not populated when
// the stream is opened with a read handle.
Metadata *Object `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// This field is periodically refreshed, however it might not be set in
// every response. It allows the client to more efficiently open subsequent
// bidirectional streams to the same object.
ReadHandle *BidiReadHandle `protobuf:"bytes,7,opt,name=read_handle,json=readHandle,proto3" json:"read_handle,omitempty"`
// contains filtered or unexported fields
}
Response message for [BidiReadObject][google.storage.v2.Storage.BidiReadObject].
func (*BidiReadObjectResponse) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadObjectResponse.ProtoReflect.Descriptor instead.
func (*BidiReadObjectResponse) GetMetadata ¶ added in v1.50.0
func (x *BidiReadObjectResponse) GetMetadata() *Object
func (*BidiReadObjectResponse) GetObjectDataRanges ¶ added in v1.50.0
func (x *BidiReadObjectResponse) GetObjectDataRanges() []*ObjectRangeData
func (*BidiReadObjectResponse) GetReadHandle ¶ added in v1.50.0
func (x *BidiReadObjectResponse) GetReadHandle() *BidiReadHandle
func (*BidiReadObjectResponse) ProtoMessage ¶ added in v1.50.0
func (*BidiReadObjectResponse) ProtoMessage()
func (*BidiReadObjectResponse) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadObjectResponse) ProtoReflect() protoreflect.Message
func (*BidiReadObjectResponse) Reset ¶ added in v1.50.0
func (x *BidiReadObjectResponse) Reset()
func (*BidiReadObjectResponse) String ¶ added in v1.50.0
func (x *BidiReadObjectResponse) String() string
type BidiReadObjectSpec ¶ added in v1.50.0
type BidiReadObjectSpec struct {
// Required. The name of the bucket containing the object to read.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The name of the object to read.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Optional. If present, selects a specific revision of this object (as
// opposed to the latest version, the default).
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// Mask specifying which fields to read.
// The `checksummed_data` field and its children are always present.
// If no mask is specified, it defaults to all fields except `metadata.
// owner` and `metadata.acl`.
// `*` might be used to mean "all fields".
// As per https://google.aip.dev/161, this field is deprecated.
// As an alternative, `grpc metadata` can be used:
//
// Deprecated: Marked as deprecated in google/storage/v2/storage.proto.
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,12,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// The client can optionally set this field. The read handle is an optimized
// way of creating new streams. Read handles are generated and periodically
// refreshed from prior reads.
ReadHandle *BidiReadHandle `protobuf:"bytes,13,opt,name=read_handle,json=readHandle,proto3,oneof" json:"read_handle,omitempty"`
// The routing token that influences request routing for the stream. Must be
// provided if a BidiReadObjectRedirectedError is returned.
RoutingToken *string `protobuf:"bytes,14,opt,name=routing_token,json=routingToken,proto3,oneof" json:"routing_token,omitempty"`
// contains filtered or unexported fields
}
Describes the object to read in a BidiReadObject request.
func (*BidiReadObjectSpec) Descriptor
deprecated
added in
v1.50.0
func (*BidiReadObjectSpec) Descriptor() ([]byte, []int)
Deprecated: Use BidiReadObjectSpec.ProtoReflect.Descriptor instead.
func (*BidiReadObjectSpec) GetBucket ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetBucket() string
func (*BidiReadObjectSpec) GetCommonObjectRequestParams ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*BidiReadObjectSpec) GetGeneration ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetGeneration() int64
func (*BidiReadObjectSpec) GetIfGenerationMatch ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetIfGenerationMatch() int64
func (*BidiReadObjectSpec) GetIfGenerationNotMatch ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetIfGenerationNotMatch() int64
func (*BidiReadObjectSpec) GetIfMetagenerationMatch ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetIfMetagenerationMatch() int64
func (*BidiReadObjectSpec) GetIfMetagenerationNotMatch ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetIfMetagenerationNotMatch() int64
func (*BidiReadObjectSpec) GetObject ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetObject() string
func (*BidiReadObjectSpec) GetReadHandle ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetReadHandle() *BidiReadHandle
func (*BidiReadObjectSpec) GetReadMask
deprecated
added in
v1.50.0
func (x *BidiReadObjectSpec) GetReadMask() *fieldmaskpb.FieldMask
Deprecated: Marked as deprecated in google/storage/v2/storage.proto.
func (*BidiReadObjectSpec) GetRoutingToken ¶ added in v1.50.0
func (x *BidiReadObjectSpec) GetRoutingToken() string
func (*BidiReadObjectSpec) ProtoMessage ¶ added in v1.50.0
func (*BidiReadObjectSpec) ProtoMessage()
func (*BidiReadObjectSpec) ProtoReflect ¶ added in v1.50.0
func (x *BidiReadObjectSpec) ProtoReflect() protoreflect.Message
func (*BidiReadObjectSpec) Reset ¶ added in v1.50.0
func (x *BidiReadObjectSpec) Reset()
func (*BidiReadObjectSpec) String ¶ added in v1.50.0
func (x *BidiReadObjectSpec) String() string
type BidiWriteHandle ¶ added in v1.50.0
type BidiWriteHandle struct {
// Required. Opaque value describing a previous write.
Handle []byte `protobuf:"bytes,1,opt,name=handle,proto3" json:"handle,omitempty"`
// contains filtered or unexported fields
}
`BidiWriteHandle` contains a handle from a previous `BidiWriteObject` invocation. The client can use this instead of `BidiReadObjectSpec` as an optimized way of opening subsequent bidirectional streams to the same object.
func (*BidiWriteHandle) Descriptor
deprecated
added in
v1.50.0
func (*BidiWriteHandle) Descriptor() ([]byte, []int)
Deprecated: Use BidiWriteHandle.ProtoReflect.Descriptor instead.
func (*BidiWriteHandle) GetHandle ¶ added in v1.50.0
func (x *BidiWriteHandle) GetHandle() []byte
func (*BidiWriteHandle) ProtoMessage ¶ added in v1.50.0
func (*BidiWriteHandle) ProtoMessage()
func (*BidiWriteHandle) ProtoReflect ¶ added in v1.50.0
func (x *BidiWriteHandle) ProtoReflect() protoreflect.Message
func (*BidiWriteHandle) Reset ¶ added in v1.50.0
func (x *BidiWriteHandle) Reset()
func (*BidiWriteHandle) String ¶ added in v1.50.0
func (x *BidiWriteHandle) String() string
type BidiWriteObjectRedirectedError ¶ added in v1.50.0
type BidiWriteObjectRedirectedError struct {
// The routing token the client must use when retrying the write stream.
// This value must be provided in the header `x-goog-request-params`, with key
// `routing_token` and this string verbatim as the value.
RoutingToken *string `protobuf:"bytes,1,opt,name=routing_token,json=routingToken,proto3,oneof" json:"routing_token,omitempty"`
// Opaque value describing a previous write. If set, the client must use this
// in an AppendObjectSpec first_message when retrying the write stream. If not
// set, clients might retry the original request.
WriteHandle *BidiWriteHandle `protobuf:"bytes,2,opt,name=write_handle,json=writeHandle,proto3,oneof" json:"write_handle,omitempty"`
// The generation of the object that triggered the redirect. This is set
// iff `write_handle` is set. If set, the client must use this in an
// `AppendObjectSpec` first_message when retrying the write stream.
Generation *int64 `protobuf:"varint,3,opt,name=generation,proto3,oneof" json:"generation,omitempty"`
// contains filtered or unexported fields
}
Error proto containing details for a redirected write. This error might be attached as details for an ABORTED response to BidiWriteObject.
func (*BidiWriteObjectRedirectedError) Descriptor
deprecated
added in
v1.50.0
func (*BidiWriteObjectRedirectedError) Descriptor() ([]byte, []int)
Deprecated: Use BidiWriteObjectRedirectedError.ProtoReflect.Descriptor instead.
func (*BidiWriteObjectRedirectedError) GetGeneration ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) GetGeneration() int64
func (*BidiWriteObjectRedirectedError) GetRoutingToken ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) GetRoutingToken() string
func (*BidiWriteObjectRedirectedError) GetWriteHandle ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) GetWriteHandle() *BidiWriteHandle
func (*BidiWriteObjectRedirectedError) ProtoMessage ¶ added in v1.50.0
func (*BidiWriteObjectRedirectedError) ProtoMessage()
func (*BidiWriteObjectRedirectedError) ProtoReflect ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) ProtoReflect() protoreflect.Message
func (*BidiWriteObjectRedirectedError) Reset ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) Reset()
func (*BidiWriteObjectRedirectedError) String ¶ added in v1.50.0
func (x *BidiWriteObjectRedirectedError) String() string
type BidiWriteObjectRequest ¶ added in v1.34.0
type BidiWriteObjectRequest struct {
// The first message of each stream should set one of the following.
//
// Types that are assignable to FirstMessage:
//
// *BidiWriteObjectRequest_UploadId
// *BidiWriteObjectRequest_WriteObjectSpec
// *BidiWriteObjectRequest_AppendObjectSpec
FirstMessage isBidiWriteObjectRequest_FirstMessage `protobuf_oneof:"first_message"`
// Required. The offset from the beginning of the object at which the data
// should be written.
//
// In the first `WriteObjectRequest` of a `WriteObject()` action, it
// indicates the initial offset for the `Write()` call. The value must be
// equal to the `persisted_size` that a call to `QueryWriteStatus()` would
// return (0 if this is the first write to the object).
//
// On subsequent calls, this value must be no larger than the sum of the
// first `write_offset` and the sizes of all `data` chunks sent previously on
// this stream.
//
// An invalid value causes an error.
WriteOffset int64 `protobuf:"varint,3,opt,name=write_offset,json=writeOffset,proto3" json:"write_offset,omitempty"`
// A portion of the data for the object.
//
// Types that are assignable to Data:
//
// *BidiWriteObjectRequest_ChecksummedData
Data isBidiWriteObjectRequest_Data `protobuf_oneof:"data"`
// Optional. Checksums for the complete object. If the checksums computed by
// the service don't match the specified checksums the call fails. Might only
// be provided in the first request or the last request (with finish_write
// set).
ObjectChecksums *ObjectChecksums `protobuf:"bytes,6,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// Optional. For each `BidiWriteObjectRequest` where `state_lookup` is `true`
// or the client closes the stream, the service sends a
// `BidiWriteObjectResponse` containing the current persisted size. The
// persisted size sent in responses covers all the bytes the server has
// persisted thus far and can be used to decide what data is safe for the
// client to drop. Note that the object's current size reported by the
// `BidiWriteObjectResponse` might lag behind the number of bytes written by
// the client. This field is ignored if `finish_write` is set to true.
StateLookup bool `protobuf:"varint,7,opt,name=state_lookup,json=stateLookup,proto3" json:"state_lookup,omitempty"`
// Optional. Persists data written on the stream, up to and including the
// current message, to permanent storage. This option should be used sparingly
// as it might reduce performance. Ongoing writes are periodically persisted
// on the server even when `flush` is not set. This field is ignored if
// `finish_write` is set to true since there's no need to checkpoint or flush
// if this message completes the write.
Flush bool `protobuf:"varint,8,opt,name=flush,proto3" json:"flush,omitempty"`
// Optional. If `true`, this indicates that the write is complete. Sending any
// `WriteObjectRequest`s subsequent to one in which `finish_write` is `true`
// causes an error.
// For a non-resumable write (where the `upload_id` was not set in the first
// message), it is an error not to set this field in the final message of the
// stream.
FinishWrite bool `protobuf:"varint,9,opt,name=finish_write,json=finishWrite,proto3" json:"finish_write,omitempty"`
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [BidiWriteObject][google.storage.v2.Storage.BidiWriteObject].
func (*BidiWriteObjectRequest) Descriptor
deprecated
added in
v1.34.0
func (*BidiWriteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use BidiWriteObjectRequest.ProtoReflect.Descriptor instead.
func (*BidiWriteObjectRequest) GetAppendObjectSpec ¶ added in v1.50.0
func (x *BidiWriteObjectRequest) GetAppendObjectSpec() *AppendObjectSpec
func (*BidiWriteObjectRequest) GetChecksummedData ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetChecksummedData() *ChecksummedData
func (*BidiWriteObjectRequest) GetCommonObjectRequestParams ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*BidiWriteObjectRequest) GetData ¶ added in v1.34.0
func (m *BidiWriteObjectRequest) GetData() isBidiWriteObjectRequest_Data
func (*BidiWriteObjectRequest) GetFinishWrite ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetFinishWrite() bool
func (*BidiWriteObjectRequest) GetFirstMessage ¶ added in v1.34.0
func (m *BidiWriteObjectRequest) GetFirstMessage() isBidiWriteObjectRequest_FirstMessage
func (*BidiWriteObjectRequest) GetFlush ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetFlush() bool
func (*BidiWriteObjectRequest) GetObjectChecksums ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetObjectChecksums() *ObjectChecksums
func (*BidiWriteObjectRequest) GetStateLookup ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetStateLookup() bool
func (*BidiWriteObjectRequest) GetUploadId ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetUploadId() string
func (*BidiWriteObjectRequest) GetWriteObjectSpec ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec
func (*BidiWriteObjectRequest) GetWriteOffset ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) GetWriteOffset() int64
func (*BidiWriteObjectRequest) ProtoMessage ¶ added in v1.34.0
func (*BidiWriteObjectRequest) ProtoMessage()
func (*BidiWriteObjectRequest) ProtoReflect ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) ProtoReflect() protoreflect.Message
func (*BidiWriteObjectRequest) Reset ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) Reset()
func (*BidiWriteObjectRequest) String ¶ added in v1.34.0
func (x *BidiWriteObjectRequest) String() string
type BidiWriteObjectRequest_AppendObjectSpec ¶ added in v1.50.0
type BidiWriteObjectRequest_AppendObjectSpec struct {
// For appendable uploads. Describes the object to append to.
AppendObjectSpec *AppendObjectSpec `protobuf:"bytes,11,opt,name=append_object_spec,json=appendObjectSpec,proto3,oneof"`
}
type BidiWriteObjectRequest_ChecksummedData ¶ added in v1.34.0
type BidiWriteObjectRequest_ChecksummedData struct {
// The data to insert. If a crc32c checksum is provided that doesn't match
// the checksum computed by the service, the request fails.
ChecksummedData *ChecksummedData `protobuf:"bytes,4,opt,name=checksummed_data,json=checksummedData,proto3,oneof"`
}
type BidiWriteObjectRequest_UploadId ¶ added in v1.34.0
type BidiWriteObjectRequest_UploadId struct {
// For resumable uploads. This should be the `upload_id` returned from a
// call to `StartResumableWriteResponse`.
UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3,oneof"`
}
type BidiWriteObjectRequest_WriteObjectSpec ¶ added in v1.34.0
type BidiWriteObjectRequest_WriteObjectSpec struct {
// For non-resumable uploads. Describes the overall upload, including the
// destination bucket and object name, preconditions, etc.
WriteObjectSpec *WriteObjectSpec `protobuf:"bytes,2,opt,name=write_object_spec,json=writeObjectSpec,proto3,oneof"`
}
type BidiWriteObjectResponse ¶ added in v1.34.0
type BidiWriteObjectResponse struct {
// The response sets one of the following.
//
// Types that are assignable to WriteStatus:
//
// *BidiWriteObjectResponse_PersistedSize
// *BidiWriteObjectResponse_Resource
WriteStatus isBidiWriteObjectResponse_WriteStatus `protobuf_oneof:"write_status"`
// An optional write handle that is returned periodically in response
// messages. Clients should save it for later use in establishing a new stream
// if a connection is interrupted.
WriteHandle *BidiWriteHandle `protobuf:"bytes,3,opt,name=write_handle,json=writeHandle,proto3,oneof" json:"write_handle,omitempty"`
// contains filtered or unexported fields
}
Response message for BidiWriteObject.
func (*BidiWriteObjectResponse) Descriptor
deprecated
added in
v1.34.0
func (*BidiWriteObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use BidiWriteObjectResponse.ProtoReflect.Descriptor instead.
func (*BidiWriteObjectResponse) GetPersistedSize ¶ added in v1.34.0
func (x *BidiWriteObjectResponse) GetPersistedSize() int64
func (*BidiWriteObjectResponse) GetResource ¶ added in v1.34.0
func (x *BidiWriteObjectResponse) GetResource() *Object
func (*BidiWriteObjectResponse) GetWriteHandle ¶ added in v1.50.0
func (x *BidiWriteObjectResponse) GetWriteHandle() *BidiWriteHandle
func (*BidiWriteObjectResponse) GetWriteStatus ¶ added in v1.34.0
func (m *BidiWriteObjectResponse) GetWriteStatus() isBidiWriteObjectResponse_WriteStatus
func (*BidiWriteObjectResponse) ProtoMessage ¶ added in v1.34.0
func (*BidiWriteObjectResponse) ProtoMessage()
func (*BidiWriteObjectResponse) ProtoReflect ¶ added in v1.34.0
func (x *BidiWriteObjectResponse) ProtoReflect() protoreflect.Message
func (*BidiWriteObjectResponse) Reset ¶ added in v1.34.0
func (x *BidiWriteObjectResponse) Reset()
func (*BidiWriteObjectResponse) String ¶ added in v1.34.0
func (x *BidiWriteObjectResponse) String() string
type BidiWriteObjectResponse_PersistedSize ¶ added in v1.34.0
type BidiWriteObjectResponse_PersistedSize struct {
// The total number of bytes that have been processed for the given object
// from all `WriteObject` calls. Only set if the upload has not finalized.
PersistedSize int64 `protobuf:"varint,1,opt,name=persisted_size,json=persistedSize,proto3,oneof"`
}
type BidiWriteObjectResponse_Resource ¶ added in v1.34.0
type BidiWriteObjectResponse_Resource struct {
// A resource containing the metadata for the uploaded object. Only set if
// the upload has finalized.
Resource *Object `protobuf:"bytes,2,opt,name=resource,proto3,oneof"`
}
type Bucket ¶
type Bucket struct {
// Identifier. The name of the bucket.
// Format: `projects/{project}/buckets/{bucket}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The user-chosen part of the bucket name. The `{bucket}`
// portion of the `name` field. For globally unique buckets, this is equal to
// the `bucket name` of other Cloud Storage APIs. Example: `pub`.
BucketId string `protobuf:"bytes,2,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
// The etag of the bucket.
// If included in the metadata of an `UpdateBucketRequest`, the operation is
// only performed if the `etag` matches that of the bucket.
Etag string `protobuf:"bytes,29,opt,name=etag,proto3" json:"etag,omitempty"`
// Immutable. The project which owns this bucket, in the format of
// `projects/{projectIdentifier}`.
// `{projectIdentifier}` can be the project ID or project number.
// Output values are always in the project number format.
Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
// Output only. The metadata generation of this bucket.
Metageneration int64 `protobuf:"varint,4,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// Immutable. The location of the bucket. Object data for objects in the
// bucket resides in physical storage within this region. Defaults to `US`.
// Attempting to update this field after the bucket is created results in an
// error.
Location string `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"`
// Output only. The location type of the bucket (region, dual-region,
// multi-region, etc).
LocationType string `protobuf:"bytes,6,opt,name=location_type,json=locationType,proto3" json:"location_type,omitempty"`
// Optional. The bucket's default storage class, used whenever no storageClass
// is specified for a newly-created object. This defines how objects in the
// bucket are stored and determines the SLA and the cost of storage.
// If this value is not specified when the bucket is created, it defaults
// to `STANDARD`. For more information, see [Storage
// classes](https://developers.google.com/storage/docs/storage-classes).
StorageClass string `protobuf:"bytes,7,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
// Optional. The recovery point objective for cross-region replication of the
// bucket. Applicable only for dual- and multi-region buckets. `DEFAULT` uses
// default replication. `ASYNC_TURBO` enables turbo replication, valid for
// dual-region buckets only. If rpo is not specified when the bucket is
// created, it defaults to `DEFAULT`. For more information, see [Turbo
// replication](https://cloud.google.com/storage/docs/availability-durability#turbo-replication).
Rpo string `protobuf:"bytes,27,opt,name=rpo,proto3" json:"rpo,omitempty"`
// Optional. Access controls on the bucket.
// If `iam_config.uniform_bucket_level_access` is enabled on this bucket,
// requests to set, read, or modify acl is an error.
Acl []*BucketAccessControl `protobuf:"bytes,8,rep,name=acl,proto3" json:"acl,omitempty"`
// Optional. Default access controls to apply to new objects when no ACL is
// provided. If `iam_config.uniform_bucket_level_access` is enabled on this
// bucket, requests to set, read, or modify acl is an error.
DefaultObjectAcl []*ObjectAccessControl `protobuf:"bytes,9,rep,name=default_object_acl,json=defaultObjectAcl,proto3" json:"default_object_acl,omitempty"`
// Optional. The bucket's lifecycle configuration. See [Lifecycle
// Management](https://developers.google.com/storage/docs/lifecycle) for more
// information.
Lifecycle *Bucket_Lifecycle `protobuf:"bytes,10,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// Output only. The creation time of the bucket.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Optional. The bucket's [CORS](https://www.w3.org/TR/cors/)
// configuration.
Cors []*Bucket_Cors `protobuf:"bytes,12,rep,name=cors,proto3" json:"cors,omitempty"`
// Output only. The modification time of the bucket.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The default value for event-based hold on newly created objects
// in this bucket. Event-based hold is a way to retain objects indefinitely
// until an event occurs, signified by the hold's release. After being
// released, such objects are subject to bucket-level retention (if any). One
// sample use case of this flag is for banks to hold loan documents for at
// least 3 years after loan is paid in full. Here, bucket-level retention is 3
// years and the event is loan being paid in full. In this example, these
// objects are held intact for any number of years until the event has
// occurred (event-based hold on the object is released) and then 3 more years
// after that. That means retention duration of the objects begins from the
// moment event-based hold transitioned from true to false. Objects under
// event-based hold cannot be deleted, overwritten or archived until the hold
// is removed.
DefaultEventBasedHold bool `` /* 130-byte string literal not displayed */
// Optional. User-provided labels, in key/value pairs.
Labels map[string]string `` /* 154-byte string literal not displayed */
// Optional. The bucket's website config, controlling how the service behaves
// when accessing bucket contents as a web site. See the [Static website
// examples](https://cloud.google.com/storage/docs/static-website) for more
// information.
Website *Bucket_Website `protobuf:"bytes,16,opt,name=website,proto3" json:"website,omitempty"`
// Optional. The bucket's versioning configuration.
Versioning *Bucket_Versioning `protobuf:"bytes,17,opt,name=versioning,proto3" json:"versioning,omitempty"`
// Optional. The bucket's logging config, which defines the destination bucket
// and name prefix (if any) for the current bucket's logs.
Logging *Bucket_Logging `protobuf:"bytes,18,opt,name=logging,proto3" json:"logging,omitempty"`
// Output only. The owner of the bucket. This is always the project team's
// owner group.
Owner *Owner `protobuf:"bytes,19,opt,name=owner,proto3" json:"owner,omitempty"`
// Optional. Encryption config for a bucket.
Encryption *Bucket_Encryption `protobuf:"bytes,20,opt,name=encryption,proto3" json:"encryption,omitempty"`
// Optional. The bucket's billing configuration.
Billing *Bucket_Billing `protobuf:"bytes,21,opt,name=billing,proto3" json:"billing,omitempty"`
// Optional. The bucket's retention policy. The retention policy enforces a
// minimum retention time for all objects contained in the bucket, based on
// their creation time. Any attempt to overwrite or delete objects younger
// than the retention period results in a `PERMISSION_DENIED` error. An
// unlocked retention policy can be modified or removed from the bucket via a
// storage.buckets.update operation. A locked retention policy cannot be
// removed or shortened in duration for the lifetime of the bucket.
// Attempting to remove or decrease period of a locked retention policy
// results in a `PERMISSION_DENIED` error.
RetentionPolicy *Bucket_RetentionPolicy `protobuf:"bytes,22,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"`
// Optional. The bucket's IAM configuration.
IamConfig *Bucket_IamConfig `protobuf:"bytes,23,opt,name=iam_config,json=iamConfig,proto3" json:"iam_config,omitempty"`
// Optional. Reserved for future use.
SatisfiesPzs bool `protobuf:"varint,25,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
// Optional. Configuration that, if present, specifies the data placement for
// a [configurable
// dual-region](https://cloud.google.com/storage/docs/locations#location-dr).
CustomPlacementConfig *Bucket_CustomPlacementConfig `` /* 127-byte string literal not displayed */
// Optional. The bucket's Autoclass configuration. If there is no
// configuration, the Autoclass feature is disabled and has no effect on the
// bucket.
Autoclass *Bucket_Autoclass `protobuf:"bytes,28,opt,name=autoclass,proto3" json:"autoclass,omitempty"`
// Optional. The bucket's hierarchical namespace configuration. If there is no
// configuration, the hierarchical namespace feature is disabled and has
// no effect on the bucket.
HierarchicalNamespace *Bucket_HierarchicalNamespace `protobuf:"bytes,32,opt,name=hierarchical_namespace,json=hierarchicalNamespace,proto3" json:"hierarchical_namespace,omitempty"`
// Optional. The bucket's soft delete policy. The soft delete policy prevents
// soft-deleted objects from being permanently deleted.
SoftDeletePolicy *Bucket_SoftDeletePolicy `protobuf:"bytes,31,opt,name=soft_delete_policy,json=softDeletePolicy,proto3" json:"soft_delete_policy,omitempty"`
// Optional. The bucket's object retention configuration. Must be enabled
// before objects in the bucket might have retention configured.
ObjectRetention *Bucket_ObjectRetention `protobuf:"bytes,33,opt,name=object_retention,json=objectRetention,proto3" json:"object_retention,omitempty"`
// Optional. The bucket's IP filter configuration.
IpFilter *Bucket_IpFilter `protobuf:"bytes,38,opt,name=ip_filter,json=ipFilter,proto3,oneof" json:"ip_filter,omitempty"`
// contains filtered or unexported fields
}
A bucket.
func (*Bucket) Descriptor
deprecated
func (*Bucket) GetAcl ¶
func (x *Bucket) GetAcl() []*BucketAccessControl
func (*Bucket) GetAutoclass ¶
func (x *Bucket) GetAutoclass() *Bucket_Autoclass
func (*Bucket) GetBilling ¶
func (x *Bucket) GetBilling() *Bucket_Billing
func (*Bucket) GetBucketId ¶
func (*Bucket) GetCors ¶
func (x *Bucket) GetCors() []*Bucket_Cors
func (*Bucket) GetCreateTime ¶
func (x *Bucket) GetCreateTime() *timestamppb.Timestamp
func (*Bucket) GetCustomPlacementConfig ¶
func (x *Bucket) GetCustomPlacementConfig() *Bucket_CustomPlacementConfig
func (*Bucket) GetDefaultEventBasedHold ¶
func (*Bucket) GetDefaultObjectAcl ¶
func (x *Bucket) GetDefaultObjectAcl() []*ObjectAccessControl
func (*Bucket) GetEncryption ¶
func (x *Bucket) GetEncryption() *Bucket_Encryption
func (*Bucket) GetHierarchicalNamespace ¶ added in v1.39.1
func (x *Bucket) GetHierarchicalNamespace() *Bucket_HierarchicalNamespace
func (*Bucket) GetIamConfig ¶
func (x *Bucket) GetIamConfig() *Bucket_IamConfig
func (*Bucket) GetIpFilter ¶ added in v1.55.0
func (x *Bucket) GetIpFilter() *Bucket_IpFilter
func (*Bucket) GetLifecycle ¶
func (x *Bucket) GetLifecycle() *Bucket_Lifecycle
func (*Bucket) GetLocation ¶
func (*Bucket) GetLocationType ¶
func (*Bucket) GetLogging ¶
func (x *Bucket) GetLogging() *Bucket_Logging
func (*Bucket) GetMetageneration ¶
func (*Bucket) GetObjectRetention ¶ added in v1.56.0
func (x *Bucket) GetObjectRetention() *Bucket_ObjectRetention
func (*Bucket) GetProject ¶
func (*Bucket) GetRetentionPolicy ¶
func (x *Bucket) GetRetentionPolicy() *Bucket_RetentionPolicy
func (*Bucket) GetSatisfiesPzs ¶
func (*Bucket) GetSoftDeletePolicy ¶ added in v1.34.0
func (x *Bucket) GetSoftDeletePolicy() *Bucket_SoftDeletePolicy
func (*Bucket) GetStorageClass ¶
func (*Bucket) GetUpdateTime ¶
func (x *Bucket) GetUpdateTime() *timestamppb.Timestamp
func (*Bucket) GetVersioning ¶
func (x *Bucket) GetVersioning() *Bucket_Versioning
func (*Bucket) GetWebsite ¶
func (x *Bucket) GetWebsite() *Bucket_Website
func (*Bucket) ProtoMessage ¶
func (*Bucket) ProtoMessage()
func (*Bucket) ProtoReflect ¶
func (x *Bucket) ProtoReflect() protoreflect.Message
type BucketAccessControl ¶
type BucketAccessControl struct {
// Optional. The access permission for the entity.
Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
// Optional. The ID of the access-control entry.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Optional. The entity holding the permission, in one of the following forms:
// * `user-{userid}`
// * `user-{email}`
// * `group-{groupid}`
// * `group-{email}`
// * `domain-{domain}`
// * `project-{team}-{projectnumber}`
// * `project-{team}-{projectid}`
// * `allUsers`
// * `allAuthenticatedUsers`
// Examples:
// * The user `liz@example.com` would be `user-liz@example.com`.
// * The group `example@googlegroups.com` would be
// `group-example@googlegroups.com`
// * All members of the Google Apps for Business domain `example.com` would be
// `domain-example.com`
// For project entities, `project-{team}-{projectnumber}` format is
// returned on response.
Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,omitempty"`
// Output only. The alternative entity format, if exists. For project
// entities, `project-{team}-{projectid}` format is returned in the response.
EntityAlt string `protobuf:"bytes,9,opt,name=entity_alt,json=entityAlt,proto3" json:"entity_alt,omitempty"`
// Optional. The ID for the entity, if any.
EntityId string `protobuf:"bytes,4,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// Optional. The `etag` of the `BucketAccessControl`.
// If included in the metadata of an update or delete request message, the
// operation operation is only performed if the etag matches that of the
// bucket's `BucketAccessControl`.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. The email address associated with the entity, if any.
Email string `protobuf:"bytes,5,opt,name=email,proto3" json:"email,omitempty"`
// Optional. The domain associated with the entity, if any.
Domain string `protobuf:"bytes,6,opt,name=domain,proto3" json:"domain,omitempty"`
// Optional. The project team associated with the entity, if any.
ProjectTeam *ProjectTeam `protobuf:"bytes,7,opt,name=project_team,json=projectTeam,proto3" json:"project_team,omitempty"`
// contains filtered or unexported fields
}
An access-control entry.
func (*BucketAccessControl) Descriptor
deprecated
func (*BucketAccessControl) Descriptor() ([]byte, []int)
Deprecated: Use BucketAccessControl.ProtoReflect.Descriptor instead.
func (*BucketAccessControl) GetDomain ¶
func (x *BucketAccessControl) GetDomain() string
func (*BucketAccessControl) GetEmail ¶
func (x *BucketAccessControl) GetEmail() string
func (*BucketAccessControl) GetEntity ¶
func (x *BucketAccessControl) GetEntity() string
func (*BucketAccessControl) GetEntityAlt ¶
func (x *BucketAccessControl) GetEntityAlt() string
func (*BucketAccessControl) GetEntityId ¶
func (x *BucketAccessControl) GetEntityId() string
func (*BucketAccessControl) GetEtag ¶
func (x *BucketAccessControl) GetEtag() string
func (*BucketAccessControl) GetId ¶
func (x *BucketAccessControl) GetId() string
func (*BucketAccessControl) GetProjectTeam ¶
func (x *BucketAccessControl) GetProjectTeam() *ProjectTeam
func (*BucketAccessControl) GetRole ¶
func (x *BucketAccessControl) GetRole() string
func (*BucketAccessControl) ProtoMessage ¶
func (*BucketAccessControl) ProtoMessage()
func (*BucketAccessControl) ProtoReflect ¶
func (x *BucketAccessControl) ProtoReflect() protoreflect.Message
func (*BucketAccessControl) Reset ¶
func (x *BucketAccessControl) Reset()
func (*BucketAccessControl) String ¶
func (x *BucketAccessControl) String() string
type Bucket_Autoclass ¶
type Bucket_Autoclass struct {
// Optional. Enables Autoclass.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Output only. Latest instant at which the `enabled` field was set to true
// after being disabled/unconfigured or set to false after being enabled. If
// Autoclass is enabled when the bucket is created, the value of the
// `toggle_time` field is set to the bucket `create_time`.
ToggleTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=toggle_time,json=toggleTime,proto3" json:"toggle_time,omitempty"`
// An object in an Autoclass bucket eventually cools down to the
// terminal storage class if there is no access to the object.
// The only valid values are NEARLINE and ARCHIVE.
TerminalStorageClass *string `` /* 129-byte string literal not displayed */
// Output only. Latest instant at which the autoclass terminal storage class
// was updated.
TerminalStorageClassUpdateTime *timestamppb.Timestamp `` /* 163-byte string literal not displayed */
// contains filtered or unexported fields
}
Configuration for a bucket's Autoclass feature.
func (*Bucket_Autoclass) Descriptor
deprecated
func (*Bucket_Autoclass) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Autoclass.ProtoReflect.Descriptor instead.
func (*Bucket_Autoclass) GetEnabled ¶
func (x *Bucket_Autoclass) GetEnabled() bool
func (*Bucket_Autoclass) GetTerminalStorageClass ¶ added in v1.34.0
func (x *Bucket_Autoclass) GetTerminalStorageClass() string
func (*Bucket_Autoclass) GetTerminalStorageClassUpdateTime ¶ added in v1.34.0
func (x *Bucket_Autoclass) GetTerminalStorageClassUpdateTime() *timestamppb.Timestamp
func (*Bucket_Autoclass) GetToggleTime ¶
func (x *Bucket_Autoclass) GetToggleTime() *timestamppb.Timestamp
func (*Bucket_Autoclass) ProtoMessage ¶
func (*Bucket_Autoclass) ProtoMessage()
func (*Bucket_Autoclass) ProtoReflect ¶
func (x *Bucket_Autoclass) ProtoReflect() protoreflect.Message
func (*Bucket_Autoclass) Reset ¶
func (x *Bucket_Autoclass) Reset()
func (*Bucket_Autoclass) String ¶
func (x *Bucket_Autoclass) String() string
type Bucket_Billing ¶
type Bucket_Billing struct {
// Optional. When set to true, Requester Pays is enabled for this bucket.
RequesterPays bool `protobuf:"varint,1,opt,name=requester_pays,json=requesterPays,proto3" json:"requester_pays,omitempty"`
// contains filtered or unexported fields
}
Billing properties of a bucket.
func (*Bucket_Billing) Descriptor
deprecated
func (*Bucket_Billing) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Billing.ProtoReflect.Descriptor instead.
func (*Bucket_Billing) GetRequesterPays ¶
func (x *Bucket_Billing) GetRequesterPays() bool
func (*Bucket_Billing) ProtoMessage ¶
func (*Bucket_Billing) ProtoMessage()
func (*Bucket_Billing) ProtoReflect ¶
func (x *Bucket_Billing) ProtoReflect() protoreflect.Message
func (*Bucket_Billing) Reset ¶
func (x *Bucket_Billing) Reset()
func (*Bucket_Billing) String ¶
func (x *Bucket_Billing) String() string
type Bucket_Cors ¶
type Bucket_Cors struct {
// Optional. The list of origins eligible to receive CORS response headers.
// For more information about origins, see [RFC
// 6454](https://tools.ietf.org/html/rfc6454). Note: `*` is permitted in the
// list of origins, and means `any origin`.
Origin []string `protobuf:"bytes,1,rep,name=origin,proto3" json:"origin,omitempty"`
// Optional. The list of HTTP methods on which to include CORS response
// headers,
// (`GET`, `OPTIONS`, `POST`, etc) Note: `*` is permitted in the list of
// methods, and means "any method".
Method []string `protobuf:"bytes,2,rep,name=method,proto3" json:"method,omitempty"`
// Optional. The list of HTTP headers other than the [simple response
// headers](https://www.w3.org/TR/cors/#simple-response-headers) to give
// permission for the user-agent to share across domains.
ResponseHeader []string `protobuf:"bytes,3,rep,name=response_header,json=responseHeader,proto3" json:"response_header,omitempty"`
// Optional. The value, in seconds, to return in the [Access-Control-Max-Age
// header](https://www.w3.org/TR/cors/#access-control-max-age-response-header)
// used in preflight responses.
MaxAgeSeconds int32 `protobuf:"varint,4,opt,name=max_age_seconds,json=maxAgeSeconds,proto3" json:"max_age_seconds,omitempty"`
// contains filtered or unexported fields
}
Cross-Origin Response sharing (CORS) properties for a bucket. For more on Cloud Storage and CORS, see https://cloud.google.com/storage/docs/cross-origin. For more on CORS in general, see https://tools.ietf.org/html/rfc6454.
func (*Bucket_Cors) Descriptor
deprecated
func (*Bucket_Cors) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Cors.ProtoReflect.Descriptor instead.
func (*Bucket_Cors) GetMaxAgeSeconds ¶
func (x *Bucket_Cors) GetMaxAgeSeconds() int32
func (*Bucket_Cors) GetMethod ¶
func (x *Bucket_Cors) GetMethod() []string
func (*Bucket_Cors) GetOrigin ¶
func (x *Bucket_Cors) GetOrigin() []string
func (*Bucket_Cors) GetResponseHeader ¶
func (x *Bucket_Cors) GetResponseHeader() []string
func (*Bucket_Cors) ProtoMessage ¶
func (*Bucket_Cors) ProtoMessage()
func (*Bucket_Cors) ProtoReflect ¶
func (x *Bucket_Cors) ProtoReflect() protoreflect.Message
func (*Bucket_Cors) Reset ¶
func (x *Bucket_Cors) Reset()
func (*Bucket_Cors) String ¶
func (x *Bucket_Cors) String() string
type Bucket_CustomPlacementConfig ¶
type Bucket_CustomPlacementConfig struct {
// Optional. List of locations to use for data placement.
DataLocations []string `protobuf:"bytes,1,rep,name=data_locations,json=dataLocations,proto3" json:"data_locations,omitempty"`
// contains filtered or unexported fields
}
Configuration for [configurable dual- regions](https://cloud.google.com/storage/docs/locations#configurable). It should specify precisely two eligible regions within the same multi-region. For details, see [locations](https://cloud.google.com/storage/docs/locations).
func (*Bucket_CustomPlacementConfig) Descriptor
deprecated
func (*Bucket_CustomPlacementConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_CustomPlacementConfig.ProtoReflect.Descriptor instead.
func (*Bucket_CustomPlacementConfig) GetDataLocations ¶
func (x *Bucket_CustomPlacementConfig) GetDataLocations() []string
func (*Bucket_CustomPlacementConfig) ProtoMessage ¶
func (*Bucket_CustomPlacementConfig) ProtoMessage()
func (*Bucket_CustomPlacementConfig) ProtoReflect ¶
func (x *Bucket_CustomPlacementConfig) ProtoReflect() protoreflect.Message
func (*Bucket_CustomPlacementConfig) Reset ¶
func (x *Bucket_CustomPlacementConfig) Reset()
func (*Bucket_CustomPlacementConfig) String ¶
func (x *Bucket_CustomPlacementConfig) String() string
type Bucket_Encryption ¶
type Bucket_Encryption struct {
// Optional. The name of the Cloud KMS key that is used to encrypt objects
// inserted into this bucket, if no encryption method is specified.
DefaultKmsKey string `protobuf:"bytes,1,opt,name=default_kms_key,json=defaultKmsKey,proto3" json:"default_kms_key,omitempty"`
// Optional. If omitted, then new objects with GMEK encryption-type is
// allowed. If set, then new objects created in this bucket must comply with
// enforcement config. Changing this has no effect on existing objects; it
// applies to new objects only.
GoogleManagedEncryptionEnforcementConfig *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig `` /* 193-byte string literal not displayed */
// Optional. If omitted, then new objects with CMEK encryption-type is
// allowed. If set, then new objects created in this bucket must comply with
// enforcement config. Changing this has no effect on existing objects; it
// applies to new objects only.
CustomerManagedEncryptionEnforcementConfig *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig `` /* 199-byte string literal not displayed */
// Optional. If omitted, then new objects with CSEK encryption-type is
// allowed. If set, then new objects created in this bucket must comply with
// enforcement config. Changing this has no effect on existing objects; it
// applies to new objects only.
CustomerSuppliedEncryptionEnforcementConfig *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig `` /* 202-byte string literal not displayed */
// contains filtered or unexported fields
}
Encryption properties of a bucket.
func (*Bucket_Encryption) Descriptor
deprecated
func (*Bucket_Encryption) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption.ProtoReflect.Descriptor instead.
func (*Bucket_Encryption) GetCustomerManagedEncryptionEnforcementConfig ¶ added in v1.56.0
func (x *Bucket_Encryption) GetCustomerManagedEncryptionEnforcementConfig() *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig
func (*Bucket_Encryption) GetCustomerSuppliedEncryptionEnforcementConfig ¶ added in v1.56.0
func (x *Bucket_Encryption) GetCustomerSuppliedEncryptionEnforcementConfig() *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig
func (*Bucket_Encryption) GetDefaultKmsKey ¶
func (x *Bucket_Encryption) GetDefaultKmsKey() string
func (*Bucket_Encryption) GetGoogleManagedEncryptionEnforcementConfig ¶ added in v1.56.0
func (x *Bucket_Encryption) GetGoogleManagedEncryptionEnforcementConfig() *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig
func (*Bucket_Encryption) ProtoMessage ¶
func (*Bucket_Encryption) ProtoMessage()
func (*Bucket_Encryption) ProtoReflect ¶
func (x *Bucket_Encryption) ProtoReflect() protoreflect.Message
func (*Bucket_Encryption) Reset ¶
func (x *Bucket_Encryption) Reset()
func (*Bucket_Encryption) String ¶
func (x *Bucket_Encryption) String() string
type Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig ¶ added in v1.56.0
type Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig struct {
// Restriction mode for customer-managed encryption for new objects within
// the bucket. Valid values are: `NotRestricted` and `FullyRestricted`.
// If `NotRestricted` or unset, creation of new objects with
// customer-managed encryption is allowed.
// If `FullyRestricted`, new objects can't be created using
// customer-managed encryption.
RestrictionMode *string `protobuf:"bytes,3,opt,name=restriction_mode,json=restrictionMode,proto3,oneof" json:"restriction_mode,omitempty"`
// Time from which the config was effective. This is service-provided.
EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=effective_time,json=effectiveTime,proto3,oneof" json:"effective_time,omitempty"`
// contains filtered or unexported fields
}
Customer Managed Encryption (CMEK) enforcement config of a bucket.
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Descriptor
deprecated
added in
v1.56.0
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig.ProtoReflect.Descriptor instead.
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetEffectiveTime ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetRestrictionMode ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) GetRestrictionMode() string
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoMessage ¶ added in v1.56.0
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoMessage()
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoReflect ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Reset ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) Reset()
func (*Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) String ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerManagedEncryptionEnforcementConfig) String() string
type Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig ¶ added in v1.56.0
type Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig struct {
// Restriction mode for customer-supplied encryption for new objects
// within the bucket. Valid values are: `NotRestricted` and
// `FullyRestricted`.
// If `NotRestricted` or unset, creation of new objects with
// customer-supplied encryption is allowed.
// If `FullyRestricted`, new objects can't be created using
// customer-supplied encryption.
RestrictionMode *string `protobuf:"bytes,3,opt,name=restriction_mode,json=restrictionMode,proto3,oneof" json:"restriction_mode,omitempty"`
// Time from which the config was effective. This is service-provided.
EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=effective_time,json=effectiveTime,proto3,oneof" json:"effective_time,omitempty"`
// contains filtered or unexported fields
}
Customer Supplied Encryption (CSEK) enforcement config of a bucket.
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Descriptor
deprecated
added in
v1.56.0
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig.ProtoReflect.Descriptor instead.
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetEffectiveTime ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetRestrictionMode ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) GetRestrictionMode() string
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoMessage ¶ added in v1.56.0
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoMessage()
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoReflect ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Reset ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) Reset()
func (*Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) String ¶ added in v1.56.0
func (x *Bucket_Encryption_CustomerSuppliedEncryptionEnforcementConfig) String() string
type Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig ¶ added in v1.56.0
type Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig struct {
// Restriction mode for google-managed encryption for new objects within
// the bucket. Valid values are: `NotRestricted` and `FullyRestricted`.
// If `NotRestricted` or unset, creation of new objects with
// google-managed encryption is allowed.
// If `FullyRestricted`, new objects can't be created using google-managed
// encryption.
RestrictionMode *string `protobuf:"bytes,3,opt,name=restriction_mode,json=restrictionMode,proto3,oneof" json:"restriction_mode,omitempty"`
// Time from which the config was effective. This is service-provided.
EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=effective_time,json=effectiveTime,proto3,oneof" json:"effective_time,omitempty"`
// contains filtered or unexported fields
}
Google Managed Encryption (GMEK) enforcement config of a bucket.
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Descriptor
deprecated
added in
v1.56.0
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig.ProtoReflect.Descriptor instead.
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetEffectiveTime ¶ added in v1.56.0
func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetEffectiveTime() *timestamppb.Timestamp
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetRestrictionMode ¶ added in v1.56.0
func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) GetRestrictionMode() string
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoMessage ¶ added in v1.56.0
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoMessage()
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoReflect ¶ added in v1.56.0
func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) ProtoReflect() protoreflect.Message
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Reset ¶ added in v1.56.0
func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) Reset()
func (*Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) String ¶ added in v1.56.0
func (x *Bucket_Encryption_GoogleManagedEncryptionEnforcementConfig) String() string
type Bucket_HierarchicalNamespace ¶ added in v1.39.1
type Bucket_HierarchicalNamespace struct {
// Optional. Enables the hierarchical namespace feature.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// contains filtered or unexported fields
}
Configuration for a bucket's hierarchical namespace feature.
func (*Bucket_HierarchicalNamespace) Descriptor
deprecated
added in
v1.39.1
func (*Bucket_HierarchicalNamespace) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_HierarchicalNamespace.ProtoReflect.Descriptor instead.
func (*Bucket_HierarchicalNamespace) GetEnabled ¶ added in v1.39.1
func (x *Bucket_HierarchicalNamespace) GetEnabled() bool
func (*Bucket_HierarchicalNamespace) ProtoMessage ¶ added in v1.39.1
func (*Bucket_HierarchicalNamespace) ProtoMessage()
func (*Bucket_HierarchicalNamespace) ProtoReflect ¶ added in v1.39.1
func (x *Bucket_HierarchicalNamespace) ProtoReflect() protoreflect.Message
func (*Bucket_HierarchicalNamespace) Reset ¶ added in v1.39.1
func (x *Bucket_HierarchicalNamespace) Reset()
func (*Bucket_HierarchicalNamespace) String ¶ added in v1.39.1
func (x *Bucket_HierarchicalNamespace) String() string
type Bucket_IamConfig ¶
type Bucket_IamConfig struct {
// Optional. Bucket restriction options currently enforced on the bucket.
UniformBucketLevelAccess *Bucket_IamConfig_UniformBucketLevelAccess `` /* 137-byte string literal not displayed */
// Optional. Whether IAM enforces public access prevention. Valid values are
// `enforced` or `inherited`.
PublicAccessPrevention string `` /* 129-byte string literal not displayed */
// contains filtered or unexported fields
}
Bucket restriction options.
func (*Bucket_IamConfig) Descriptor
deprecated
func (*Bucket_IamConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfig.ProtoReflect.Descriptor instead.
func (*Bucket_IamConfig) GetPublicAccessPrevention ¶
func (x *Bucket_IamConfig) GetPublicAccessPrevention() string
func (*Bucket_IamConfig) GetUniformBucketLevelAccess ¶
func (x *Bucket_IamConfig) GetUniformBucketLevelAccess() *Bucket_IamConfig_UniformBucketLevelAccess
func (*Bucket_IamConfig) ProtoMessage ¶
func (*Bucket_IamConfig) ProtoMessage()
func (*Bucket_IamConfig) ProtoReflect ¶
func (x *Bucket_IamConfig) ProtoReflect() protoreflect.Message
func (*Bucket_IamConfig) Reset ¶
func (x *Bucket_IamConfig) Reset()
func (*Bucket_IamConfig) String ¶
func (x *Bucket_IamConfig) String() string
type Bucket_IamConfig_UniformBucketLevelAccess ¶
type Bucket_IamConfig_UniformBucketLevelAccess struct {
// Optional. If set, access checks only use bucket-level IAM policies or
// above.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. The deadline time for changing
// `iam_config.uniform_bucket_level_access.enabled` from `true` to
// `false`. Mutable until the specified deadline is reached, but not
// afterward.
LockTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=lock_time,json=lockTime,proto3" json:"lock_time,omitempty"`
// contains filtered or unexported fields
}
Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access.
func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor
deprecated
func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfig_UniformBucketLevelAccess.ProtoReflect.Descriptor instead.
func (*Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled ¶
func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled() bool
func (*Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime ¶
func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime() *timestamppb.Timestamp
func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage ¶
func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage()
func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect ¶
func (x *Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect() protoreflect.Message
func (*Bucket_IamConfig_UniformBucketLevelAccess) Reset ¶
func (x *Bucket_IamConfig_UniformBucketLevelAccess) Reset()
func (*Bucket_IamConfig_UniformBucketLevelAccess) String ¶
func (x *Bucket_IamConfig_UniformBucketLevelAccess) String() string
type Bucket_IpFilter ¶ added in v1.55.0
type Bucket_IpFilter struct {
// The state of the IP filter configuration. Valid values are `Enabled` and
// `Disabled`. When set to `Enabled`, IP filtering rules are applied to a
// bucket and all incoming requests to the bucket are evaluated against
// these rules. When set to `Disabled`, IP filtering rules are not applied
// to a bucket.
Mode *string `protobuf:"bytes,1,opt,name=mode,proto3,oneof" json:"mode,omitempty"`
// Public IPs allowed to operate or access the bucket.
PublicNetworkSource *Bucket_IpFilter_PublicNetworkSource `` /* 126-byte string literal not displayed */
// Optional. The list of network sources that are allowed to access
// operations on the bucket or the underlying objects.
VpcNetworkSources []*Bucket_IpFilter_VpcNetworkSource `protobuf:"bytes,3,rep,name=vpc_network_sources,json=vpcNetworkSources,proto3" json:"vpc_network_sources,omitempty"`
// Optional. Whether or not to allow VPCs from orgs different than the
// bucket's parent org to access the bucket. When set to true, validations
// on the existence of the VPCs won't be performed. If set to false, each
// VPC network source is checked to belong to the same org as the bucket as
// well as validated for existence.
AllowCrossOrgVpcs bool `protobuf:"varint,4,opt,name=allow_cross_org_vpcs,json=allowCrossOrgVpcs,proto3" json:"allow_cross_org_vpcs,omitempty"`
// Whether or not to allow all P4SA access to the bucket. When set to true,
// IP filter config validation doesn't apply.
AllowAllServiceAgentAccess *bool `` /* 152-byte string literal not displayed */
// contains filtered or unexported fields
}
The [bucket IP filtering](https://cloud.google.com/storage/docs/ip-filtering-overview) configuration. Specifies the network sources that can access the bucket, as well as its underlying objects.
func (*Bucket_IpFilter) Descriptor
deprecated
added in
v1.55.0
func (*Bucket_IpFilter) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IpFilter.ProtoReflect.Descriptor instead.
func (*Bucket_IpFilter) GetAllowAllServiceAgentAccess ¶ added in v1.56.0
func (x *Bucket_IpFilter) GetAllowAllServiceAgentAccess() bool
func (*Bucket_IpFilter) GetAllowCrossOrgVpcs ¶ added in v1.55.0
func (x *Bucket_IpFilter) GetAllowCrossOrgVpcs() bool
func (*Bucket_IpFilter) GetMode ¶ added in v1.55.0
func (x *Bucket_IpFilter) GetMode() string
func (*Bucket_IpFilter) GetPublicNetworkSource ¶ added in v1.55.0
func (x *Bucket_IpFilter) GetPublicNetworkSource() *Bucket_IpFilter_PublicNetworkSource
func (*Bucket_IpFilter) GetVpcNetworkSources ¶ added in v1.55.0
func (x *Bucket_IpFilter) GetVpcNetworkSources() []*Bucket_IpFilter_VpcNetworkSource
func (*Bucket_IpFilter) ProtoMessage ¶ added in v1.55.0
func (*Bucket_IpFilter) ProtoMessage()
func (*Bucket_IpFilter) ProtoReflect ¶ added in v1.55.0
func (x *Bucket_IpFilter) ProtoReflect() protoreflect.Message
func (*Bucket_IpFilter) Reset ¶ added in v1.55.0
func (x *Bucket_IpFilter) Reset()
func (*Bucket_IpFilter) String ¶ added in v1.55.0
func (x *Bucket_IpFilter) String() string
type Bucket_IpFilter_PublicNetworkSource ¶ added in v1.55.0
type Bucket_IpFilter_PublicNetworkSource struct {
// Optional. The list of IPv4 and IPv6 cidr blocks that are allowed to
// operate or access the bucket and its underlying objects.
AllowedIpCidrRanges []string `protobuf:"bytes,1,rep,name=allowed_ip_cidr_ranges,json=allowedIpCidrRanges,proto3" json:"allowed_ip_cidr_ranges,omitempty"`
// contains filtered or unexported fields
}
The public network IP address ranges that can access the bucket and its data.
func (*Bucket_IpFilter_PublicNetworkSource) Descriptor
deprecated
added in
v1.55.0
func (*Bucket_IpFilter_PublicNetworkSource) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IpFilter_PublicNetworkSource.ProtoReflect.Descriptor instead.
func (*Bucket_IpFilter_PublicNetworkSource) GetAllowedIpCidrRanges ¶ added in v1.55.0
func (x *Bucket_IpFilter_PublicNetworkSource) GetAllowedIpCidrRanges() []string
func (*Bucket_IpFilter_PublicNetworkSource) ProtoMessage ¶ added in v1.55.0
func (*Bucket_IpFilter_PublicNetworkSource) ProtoMessage()
func (*Bucket_IpFilter_PublicNetworkSource) ProtoReflect ¶ added in v1.55.0
func (x *Bucket_IpFilter_PublicNetworkSource) ProtoReflect() protoreflect.Message
func (*Bucket_IpFilter_PublicNetworkSource) Reset ¶ added in v1.55.0
func (x *Bucket_IpFilter_PublicNetworkSource) Reset()
func (*Bucket_IpFilter_PublicNetworkSource) String ¶ added in v1.55.0
func (x *Bucket_IpFilter_PublicNetworkSource) String() string
type Bucket_IpFilter_VpcNetworkSource ¶ added in v1.55.0
type Bucket_IpFilter_VpcNetworkSource struct {
// Name of the network.
//
// Format: `projects/PROJECT_ID/global/networks/NETWORK_NAME`
Network *string `protobuf:"bytes,1,opt,name=network,proto3,oneof" json:"network,omitempty"`
// Optional. The list of public or private IPv4 and IPv6 CIDR ranges that
// can access the bucket. In the CIDR IP address block, the specified IP
// address must be properly truncated, meaning all the host bits must be
// zero or else the input is considered malformed. For example,
// `192.0.2.0/24` is accepted but `192.0.2.1/24` is not. Similarly, for
// IPv6, `2001:db8::/32` is accepted whereas `2001:db8::1/32` is not.
AllowedIpCidrRanges []string `protobuf:"bytes,2,rep,name=allowed_ip_cidr_ranges,json=allowedIpCidrRanges,proto3" json:"allowed_ip_cidr_ranges,omitempty"`
// contains filtered or unexported fields
}
The list of VPC networks that can access the bucket.
func (*Bucket_IpFilter_VpcNetworkSource) Descriptor
deprecated
added in
v1.55.0
func (*Bucket_IpFilter_VpcNetworkSource) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IpFilter_VpcNetworkSource.ProtoReflect.Descriptor instead.
func (*Bucket_IpFilter_VpcNetworkSource) GetAllowedIpCidrRanges ¶ added in v1.55.0
func (x *Bucket_IpFilter_VpcNetworkSource) GetAllowedIpCidrRanges() []string
func (*Bucket_IpFilter_VpcNetworkSource) GetNetwork ¶ added in v1.55.0
func (x *Bucket_IpFilter_VpcNetworkSource) GetNetwork() string
func (*Bucket_IpFilter_VpcNetworkSource) ProtoMessage ¶ added in v1.55.0
func (*Bucket_IpFilter_VpcNetworkSource) ProtoMessage()
func (*Bucket_IpFilter_VpcNetworkSource) ProtoReflect ¶ added in v1.55.0
func (x *Bucket_IpFilter_VpcNetworkSource) ProtoReflect() protoreflect.Message
func (*Bucket_IpFilter_VpcNetworkSource) Reset ¶ added in v1.55.0
func (x *Bucket_IpFilter_VpcNetworkSource) Reset()
func (*Bucket_IpFilter_VpcNetworkSource) String ¶ added in v1.55.0
func (x *Bucket_IpFilter_VpcNetworkSource) String() string
type Bucket_Lifecycle ¶
type Bucket_Lifecycle struct {
// Optional. A lifecycle management rule, which is made of an action to take
// and the condition under which the action is taken.
Rule []*Bucket_Lifecycle_Rule `protobuf:"bytes,1,rep,name=rule,proto3" json:"rule,omitempty"`
// contains filtered or unexported fields
}
Lifecycle properties of a bucket. For more information, see [Object Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle).
func (*Bucket_Lifecycle) Descriptor
deprecated
func (*Bucket_Lifecycle) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle.ProtoReflect.Descriptor instead.
func (*Bucket_Lifecycle) GetRule ¶
func (x *Bucket_Lifecycle) GetRule() []*Bucket_Lifecycle_Rule
func (*Bucket_Lifecycle) ProtoMessage ¶
func (*Bucket_Lifecycle) ProtoMessage()
func (*Bucket_Lifecycle) ProtoReflect ¶
func (x *Bucket_Lifecycle) ProtoReflect() protoreflect.Message
func (*Bucket_Lifecycle) Reset ¶
func (x *Bucket_Lifecycle) Reset()
func (*Bucket_Lifecycle) String ¶
func (x *Bucket_Lifecycle) String() string
type Bucket_Lifecycle_Rule ¶
type Bucket_Lifecycle_Rule struct {
// Optional. The action to take.
Action *Bucket_Lifecycle_Rule_Action `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
// Optional. The condition under which the action is taken.
Condition *Bucket_Lifecycle_Rule_Condition `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"`
// contains filtered or unexported fields
}
A lifecycle Rule, combining an action to take on an object and a condition which triggers that action.
func (*Bucket_Lifecycle_Rule) Descriptor
deprecated
func (*Bucket_Lifecycle_Rule) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule.ProtoReflect.Descriptor instead.
func (*Bucket_Lifecycle_Rule) GetAction ¶
func (x *Bucket_Lifecycle_Rule) GetAction() *Bucket_Lifecycle_Rule_Action
func (*Bucket_Lifecycle_Rule) GetCondition ¶
func (x *Bucket_Lifecycle_Rule) GetCondition() *Bucket_Lifecycle_Rule_Condition
func (*Bucket_Lifecycle_Rule) ProtoMessage ¶
func (*Bucket_Lifecycle_Rule) ProtoMessage()
func (*Bucket_Lifecycle_Rule) ProtoReflect ¶
func (x *Bucket_Lifecycle_Rule) ProtoReflect() protoreflect.Message
func (*Bucket_Lifecycle_Rule) Reset ¶
func (x *Bucket_Lifecycle_Rule) Reset()
func (*Bucket_Lifecycle_Rule) String ¶
func (x *Bucket_Lifecycle_Rule) String() string
type Bucket_Lifecycle_Rule_Action ¶
type Bucket_Lifecycle_Rule_Action struct {
// Optional. Type of the action. Currently, only `Delete`,
// `SetStorageClass`, and `AbortIncompleteMultipartUpload` are
// supported.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// Optional. Target storage class. Required iff the type of the action
// is SetStorageClass.
StorageClass string `protobuf:"bytes,2,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
// contains filtered or unexported fields
}
An action to take on an object.
func (*Bucket_Lifecycle_Rule_Action) Descriptor
deprecated
func (*Bucket_Lifecycle_Rule_Action) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule_Action.ProtoReflect.Descriptor instead.
func (*Bucket_Lifecycle_Rule_Action) GetStorageClass ¶
func (x *Bucket_Lifecycle_Rule_Action) GetStorageClass() string
func (*Bucket_Lifecycle_Rule_Action) GetType ¶
func (x *Bucket_Lifecycle_Rule_Action) GetType() string
func (*Bucket_Lifecycle_Rule_Action) ProtoMessage ¶
func (*Bucket_Lifecycle_Rule_Action) ProtoMessage()
func (*Bucket_Lifecycle_Rule_Action) ProtoReflect ¶
func (x *Bucket_Lifecycle_Rule_Action) ProtoReflect() protoreflect.Message
func (*Bucket_Lifecycle_Rule_Action) Reset ¶
func (x *Bucket_Lifecycle_Rule_Action) Reset()
func (*Bucket_Lifecycle_Rule_Action) String ¶
func (x *Bucket_Lifecycle_Rule_Action) String() string
type Bucket_Lifecycle_Rule_Condition ¶
type Bucket_Lifecycle_Rule_Condition struct {
// Age of an object (in days). This condition is satisfied when an
// object reaches the specified age.
// A value of 0 indicates that all objects immediately match this
// condition.
AgeDays *int32 `protobuf:"varint,1,opt,name=age_days,json=ageDays,proto3,oneof" json:"age_days,omitempty"`
// Optional. This condition is satisfied when an object is created
// before midnight of the specified date in UTC.
CreatedBefore *date.Date `protobuf:"bytes,2,opt,name=created_before,json=createdBefore,proto3" json:"created_before,omitempty"`
// Relevant only for versioned objects. If the value is
// `true`, this condition matches live objects; if the value
// is `false`, it matches archived objects.
IsLive *bool `protobuf:"varint,3,opt,name=is_live,json=isLive,proto3,oneof" json:"is_live,omitempty"`
// Relevant only for versioned objects. If the value is N, this
// condition is satisfied when there are at least N versions (including
// the live version) newer than this version of the object.
NumNewerVersions *int32 `protobuf:"varint,4,opt,name=num_newer_versions,json=numNewerVersions,proto3,oneof" json:"num_newer_versions,omitempty"`
// Optional. Objects having any of the storage classes specified by this
// condition are matched. Values include `MULTI_REGIONAL`, `REGIONAL`,
// `NEARLINE`, `COLDLINE`, `STANDARD`, and
// `DURABLE_REDUCED_AVAILABILITY`.
MatchesStorageClass []string `protobuf:"bytes,5,rep,name=matches_storage_class,json=matchesStorageClass,proto3" json:"matches_storage_class,omitempty"`
// Number of days that have elapsed since the custom timestamp set on an
// object.
// The value of the field must be a nonnegative integer.
DaysSinceCustomTime *int32 `` /* 129-byte string literal not displayed */
// Optional. An object matches this condition if the custom timestamp
// set on the object is before the specified date in UTC.
CustomTimeBefore *date.Date `protobuf:"bytes,8,opt,name=custom_time_before,json=customTimeBefore,proto3" json:"custom_time_before,omitempty"`
// This condition is relevant only for versioned objects. An object
// version satisfies this condition only if these many days have been
// passed since it became noncurrent. The value of the field must be a
// nonnegative integer. If it's zero, the object version becomes
// eligible for Lifecycle action as soon as it becomes noncurrent.
DaysSinceNoncurrentTime *int32 `` /* 141-byte string literal not displayed */
// Optional. This condition is relevant only for versioned objects. An
// object version satisfies this condition only if it became noncurrent
// before the specified date in UTC.
NoncurrentTimeBefore *date.Date `protobuf:"bytes,10,opt,name=noncurrent_time_before,json=noncurrentTimeBefore,proto3" json:"noncurrent_time_before,omitempty"`
// Optional. List of object name prefixes. If any prefix exactly matches
// the beginning of the object name, the condition evaluates to true.
MatchesPrefix []string `protobuf:"bytes,11,rep,name=matches_prefix,json=matchesPrefix,proto3" json:"matches_prefix,omitempty"`
// Optional. List of object name suffixes. If any suffix exactly matches
// the end of the object name, the condition evaluates to true.
MatchesSuffix []string `protobuf:"bytes,12,rep,name=matches_suffix,json=matchesSuffix,proto3" json:"matches_suffix,omitempty"`
// contains filtered or unexported fields
}
A condition of an object which triggers some action.
func (*Bucket_Lifecycle_Rule_Condition) Descriptor
deprecated
func (*Bucket_Lifecycle_Rule_Condition) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule_Condition.ProtoReflect.Descriptor instead.
func (*Bucket_Lifecycle_Rule_Condition) GetAgeDays ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetAgeDays() int32
func (*Bucket_Lifecycle_Rule_Condition) GetCreatedBefore ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetCreatedBefore() *date.Date
func (*Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore() *date.Date
func (*Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime() int32
func (*Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime() int32
func (*Bucket_Lifecycle_Rule_Condition) GetIsLive ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetIsLive() bool
func (*Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix() []string
func (*Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass() []string
func (*Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix() []string
func (*Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore() *date.Date
func (*Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions ¶
func (x *Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions() int32
func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage ¶
func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage()
func (*Bucket_Lifecycle_Rule_Condition) ProtoReflect ¶
func (x *Bucket_Lifecycle_Rule_Condition) ProtoReflect() protoreflect.Message
func (*Bucket_Lifecycle_Rule_Condition) Reset ¶
func (x *Bucket_Lifecycle_Rule_Condition) Reset()
func (*Bucket_Lifecycle_Rule_Condition) String ¶
func (x *Bucket_Lifecycle_Rule_Condition) String() string
type Bucket_Logging ¶
type Bucket_Logging struct {
// Optional. The destination bucket where the current bucket's logs should
// be placed, using path format (like `projects/123456/buckets/foo`).
LogBucket string `protobuf:"bytes,1,opt,name=log_bucket,json=logBucket,proto3" json:"log_bucket,omitempty"`
// Optional. A prefix for log object names.
LogObjectPrefix string `protobuf:"bytes,2,opt,name=log_object_prefix,json=logObjectPrefix,proto3" json:"log_object_prefix,omitempty"`
// contains filtered or unexported fields
}
Logging-related properties of a bucket.
func (*Bucket_Logging) Descriptor
deprecated
func (*Bucket_Logging) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Logging.ProtoReflect.Descriptor instead.
func (*Bucket_Logging) GetLogBucket ¶
func (x *Bucket_Logging) GetLogBucket() string
func (*Bucket_Logging) GetLogObjectPrefix ¶
func (x *Bucket_Logging) GetLogObjectPrefix() string
func (*Bucket_Logging) ProtoMessage ¶
func (*Bucket_Logging) ProtoMessage()
func (*Bucket_Logging) ProtoReflect ¶
func (x *Bucket_Logging) ProtoReflect() protoreflect.Message
func (*Bucket_Logging) Reset ¶
func (x *Bucket_Logging) Reset()
func (*Bucket_Logging) String ¶
func (x *Bucket_Logging) String() string
type Bucket_ObjectRetention ¶ added in v1.56.0
type Bucket_ObjectRetention struct {
// Optional. Output only. If true, object retention is enabled for the
// bucket.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// contains filtered or unexported fields
}
Object Retention related properties of a bucket.
func (*Bucket_ObjectRetention) Descriptor
deprecated
added in
v1.56.0
func (*Bucket_ObjectRetention) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_ObjectRetention.ProtoReflect.Descriptor instead.
func (*Bucket_ObjectRetention) GetEnabled ¶ added in v1.56.0
func (x *Bucket_ObjectRetention) GetEnabled() bool
func (*Bucket_ObjectRetention) ProtoMessage ¶ added in v1.56.0
func (*Bucket_ObjectRetention) ProtoMessage()
func (*Bucket_ObjectRetention) ProtoReflect ¶ added in v1.56.0
func (x *Bucket_ObjectRetention) ProtoReflect() protoreflect.Message
func (*Bucket_ObjectRetention) Reset ¶ added in v1.56.0
func (x *Bucket_ObjectRetention) Reset()
func (*Bucket_ObjectRetention) String ¶ added in v1.56.0
func (x *Bucket_ObjectRetention) String() string
type Bucket_RetentionPolicy ¶
type Bucket_RetentionPolicy struct {
// Optional. Server-determined value that indicates the time from which
// policy was enforced and effective.
EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=effective_time,json=effectiveTime,proto3" json:"effective_time,omitempty"`
// Optional. Once locked, an object retention policy cannot be modified.
IsLocked bool `protobuf:"varint,2,opt,name=is_locked,json=isLocked,proto3" json:"is_locked,omitempty"`
// Optional. The duration that objects need to be retained. Retention
// duration must be greater than zero and less than 100 years. Note that
// enforcement of retention periods less than a day is not guaranteed. Such
// periods should only be used for testing purposes. Any `nanos` value
// specified is rounded down to the nearest second.
RetentionDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=retention_duration,json=retentionDuration,proto3" json:"retention_duration,omitempty"`
// contains filtered or unexported fields
}
Retention policy properties of a bucket.
func (*Bucket_RetentionPolicy) Descriptor
deprecated
func (*Bucket_RetentionPolicy) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_RetentionPolicy.ProtoReflect.Descriptor instead.
func (*Bucket_RetentionPolicy) GetEffectiveTime ¶
func (x *Bucket_RetentionPolicy) GetEffectiveTime() *timestamppb.Timestamp
func (*Bucket_RetentionPolicy) GetIsLocked ¶
func (x *Bucket_RetentionPolicy) GetIsLocked() bool
func (*Bucket_RetentionPolicy) GetRetentionDuration ¶
func (x *Bucket_RetentionPolicy) GetRetentionDuration() *durationpb.Duration
func (*Bucket_RetentionPolicy) ProtoMessage ¶
func (*Bucket_RetentionPolicy) ProtoMessage()
func (*Bucket_RetentionPolicy) ProtoReflect ¶
func (x *Bucket_RetentionPolicy) ProtoReflect() protoreflect.Message
func (*Bucket_RetentionPolicy) Reset ¶
func (x *Bucket_RetentionPolicy) Reset()
func (*Bucket_RetentionPolicy) String ¶
func (x *Bucket_RetentionPolicy) String() string
type Bucket_SoftDeletePolicy ¶ added in v1.34.0
type Bucket_SoftDeletePolicy struct {
// The period of time that soft-deleted objects in the bucket must be
// retained and cannot be permanently deleted. The duration must be greater
// than or equal to 7 days and less than 1 year.
RetentionDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=retention_duration,json=retentionDuration,proto3,oneof" json:"retention_duration,omitempty"`
// Time from which the policy was effective. This is service-provided.
EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=effective_time,json=effectiveTime,proto3,oneof" json:"effective_time,omitempty"`
// contains filtered or unexported fields
}
Soft delete policy properties of a bucket.
func (*Bucket_SoftDeletePolicy) Descriptor
deprecated
added in
v1.34.0
func (*Bucket_SoftDeletePolicy) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_SoftDeletePolicy.ProtoReflect.Descriptor instead.
func (*Bucket_SoftDeletePolicy) GetEffectiveTime ¶ added in v1.34.0
func (x *Bucket_SoftDeletePolicy) GetEffectiveTime() *timestamppb.Timestamp
func (*Bucket_SoftDeletePolicy) GetRetentionDuration ¶ added in v1.34.0
func (x *Bucket_SoftDeletePolicy) GetRetentionDuration() *durationpb.Duration
func (*Bucket_SoftDeletePolicy) ProtoMessage ¶ added in v1.34.0
func (*Bucket_SoftDeletePolicy) ProtoMessage()
func (*Bucket_SoftDeletePolicy) ProtoReflect ¶ added in v1.34.0
func (x *Bucket_SoftDeletePolicy) ProtoReflect() protoreflect.Message
func (*Bucket_SoftDeletePolicy) Reset ¶ added in v1.34.0
func (x *Bucket_SoftDeletePolicy) Reset()
func (*Bucket_SoftDeletePolicy) String ¶ added in v1.34.0
func (x *Bucket_SoftDeletePolicy) String() string
type Bucket_Versioning ¶
type Bucket_Versioning struct {
// Optional. While set to true, versioning is fully enabled for this bucket.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// contains filtered or unexported fields
}
Properties of a bucket related to versioning. For more information about Cloud Storage versioning, see [Object versioning](https://cloud.google.com/storage/docs/object-versioning).
func (*Bucket_Versioning) Descriptor
deprecated
func (*Bucket_Versioning) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Versioning.ProtoReflect.Descriptor instead.
func (*Bucket_Versioning) GetEnabled ¶
func (x *Bucket_Versioning) GetEnabled() bool
func (*Bucket_Versioning) ProtoMessage ¶
func (*Bucket_Versioning) ProtoMessage()
func (*Bucket_Versioning) ProtoReflect ¶
func (x *Bucket_Versioning) ProtoReflect() protoreflect.Message
func (*Bucket_Versioning) Reset ¶
func (x *Bucket_Versioning) Reset()
func (*Bucket_Versioning) String ¶
func (x *Bucket_Versioning) String() string
type Bucket_Website ¶
type Bucket_Website struct {
// Optional. If the requested object path is missing, the service ensures
// the path has a trailing '/', append this suffix, and attempt to retrieve
// the resulting object. This allows the creation of `index.html` objects to
// represent directory pages.
MainPageSuffix string `protobuf:"bytes,1,opt,name=main_page_suffix,json=mainPageSuffix,proto3" json:"main_page_suffix,omitempty"`
// Optional. If the requested object path is missing, and any
// `mainPageSuffix` object is missing, if applicable, the service
// returns the named object from this bucket as the content for a
// [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)
// result.
NotFoundPage string `protobuf:"bytes,2,opt,name=not_found_page,json=notFoundPage,proto3" json:"not_found_page,omitempty"`
// contains filtered or unexported fields
}
Properties of a bucket related to accessing the contents as a static website. For details, see [hosting a static website using Cloud Storage](https://cloud.google.com/storage/docs/hosting-static-website).
func (*Bucket_Website) Descriptor
deprecated
func (*Bucket_Website) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Website.ProtoReflect.Descriptor instead.
func (*Bucket_Website) GetMainPageSuffix ¶
func (x *Bucket_Website) GetMainPageSuffix() string
func (*Bucket_Website) GetNotFoundPage ¶
func (x *Bucket_Website) GetNotFoundPage() string
func (*Bucket_Website) ProtoMessage ¶
func (*Bucket_Website) ProtoMessage()
func (*Bucket_Website) ProtoReflect ¶
func (x *Bucket_Website) ProtoReflect() protoreflect.Message
func (*Bucket_Website) Reset ¶
func (x *Bucket_Website) Reset()
func (*Bucket_Website) String ¶
func (x *Bucket_Website) String() string
type CancelResumableWriteRequest ¶
type CancelResumableWriteRequest struct {
// Required. The upload_id of the resumable upload to cancel. This should be
// copied from the `upload_id` field of `StartResumableWriteResponse`.
UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
// contains filtered or unexported fields
}
Request message for [CancelResumableWrite][google.storage.v2.Storage.CancelResumableWrite].
func (*CancelResumableWriteRequest) Descriptor
deprecated
func (*CancelResumableWriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use CancelResumableWriteRequest.ProtoReflect.Descriptor instead.
func (*CancelResumableWriteRequest) GetUploadId ¶
func (x *CancelResumableWriteRequest) GetUploadId() string
func (*CancelResumableWriteRequest) ProtoMessage ¶
func (*CancelResumableWriteRequest) ProtoMessage()
func (*CancelResumableWriteRequest) ProtoReflect ¶
func (x *CancelResumableWriteRequest) ProtoReflect() protoreflect.Message
func (*CancelResumableWriteRequest) Reset ¶
func (x *CancelResumableWriteRequest) Reset()
func (*CancelResumableWriteRequest) String ¶
func (x *CancelResumableWriteRequest) String() string
type CancelResumableWriteResponse ¶
type CancelResumableWriteResponse struct {
// contains filtered or unexported fields
}
Empty response message for canceling an in-progress resumable upload, is extended as needed.
func (*CancelResumableWriteResponse) Descriptor
deprecated
func (*CancelResumableWriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use CancelResumableWriteResponse.ProtoReflect.Descriptor instead.
func (*CancelResumableWriteResponse) ProtoMessage ¶
func (*CancelResumableWriteResponse) ProtoMessage()
func (*CancelResumableWriteResponse) ProtoReflect ¶
func (x *CancelResumableWriteResponse) ProtoReflect() protoreflect.Message
func (*CancelResumableWriteResponse) Reset ¶
func (x *CancelResumableWriteResponse) Reset()
func (*CancelResumableWriteResponse) String ¶
func (x *CancelResumableWriteResponse) String() string
type ChecksummedData ¶
type ChecksummedData struct {
// Optional. The data.
Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// If set, the CRC32C digest of the content field.
Crc32C *uint32 `protobuf:"fixed32,2,opt,name=crc32c,proto3,oneof" json:"crc32c,omitempty"`
// contains filtered or unexported fields
}
Message used to convey content being read or written, along with an optional checksum.
func (*ChecksummedData) Descriptor
deprecated
func (*ChecksummedData) Descriptor() ([]byte, []int)
Deprecated: Use ChecksummedData.ProtoReflect.Descriptor instead.
func (*ChecksummedData) GetContent ¶
func (x *ChecksummedData) GetContent() []byte
func (*ChecksummedData) GetCrc32C ¶
func (x *ChecksummedData) GetCrc32C() uint32
func (*ChecksummedData) ProtoMessage ¶
func (*ChecksummedData) ProtoMessage()
func (*ChecksummedData) ProtoReflect ¶
func (x *ChecksummedData) ProtoReflect() protoreflect.Message
func (*ChecksummedData) Reset ¶
func (x *ChecksummedData) Reset()
func (*ChecksummedData) String ¶
func (x *ChecksummedData) String() string
type CommonObjectRequestParams ¶
type CommonObjectRequestParams struct {
// Optional. Encryption algorithm used with the Customer-Supplied Encryption
// Keys feature.
EncryptionAlgorithm string `protobuf:"bytes,1,opt,name=encryption_algorithm,json=encryptionAlgorithm,proto3" json:"encryption_algorithm,omitempty"`
// Optional. Encryption key used with the Customer-Supplied Encryption Keys
// feature. In raw bytes format (not base64-encoded).
EncryptionKeyBytes []byte `protobuf:"bytes,4,opt,name=encryption_key_bytes,json=encryptionKeyBytes,proto3" json:"encryption_key_bytes,omitempty"`
// Optional. SHA256 hash of encryption key used with the Customer-supplied
// encryption keys feature.
EncryptionKeySha256Bytes []byte `` /* 137-byte string literal not displayed */
// contains filtered or unexported fields
}
Parameters that can be passed to any object request.
func (*CommonObjectRequestParams) Descriptor
deprecated
func (*CommonObjectRequestParams) Descriptor() ([]byte, []int)
Deprecated: Use CommonObjectRequestParams.ProtoReflect.Descriptor instead.
func (*CommonObjectRequestParams) GetEncryptionAlgorithm ¶
func (x *CommonObjectRequestParams) GetEncryptionAlgorithm() string
func (*CommonObjectRequestParams) GetEncryptionKeyBytes ¶
func (x *CommonObjectRequestParams) GetEncryptionKeyBytes() []byte
func (*CommonObjectRequestParams) GetEncryptionKeySha256Bytes ¶
func (x *CommonObjectRequestParams) GetEncryptionKeySha256Bytes() []byte
func (*CommonObjectRequestParams) ProtoMessage ¶
func (*CommonObjectRequestParams) ProtoMessage()
func (*CommonObjectRequestParams) ProtoReflect ¶
func (x *CommonObjectRequestParams) ProtoReflect() protoreflect.Message
func (*CommonObjectRequestParams) Reset ¶
func (x *CommonObjectRequestParams) Reset()
func (*CommonObjectRequestParams) String ¶
func (x *CommonObjectRequestParams) String() string
type ComposeObjectRequest ¶
type ComposeObjectRequest struct {
// Required. Properties of the resulting object.
Destination *Object `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
// Optional. The list of source objects that is concatenated into a single
// object.
SourceObjects []*ComposeObjectRequest_SourceObject `protobuf:"bytes,2,rep,name=source_objects,json=sourceObjects,proto3" json:"source_objects,omitempty"`
// Optional. Apply a predefined set of access controls to the destination
// object. Valid values are `authenticatedRead`, `bucketOwnerFullControl`,
// `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`.
DestinationPredefinedAcl string `` /* 135-byte string literal not displayed */
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Optional. Resource name of the Cloud KMS key, of the form
// `projects/my-project/locations/my-location/keyRings/my-kr/cryptoKeys/my-key`,
// that is used to encrypt the object. Overrides the object
// metadata's `kms_key_name` value, if any.
KmsKey string `protobuf:"bytes,6,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// Optional. The checksums of the complete object. This is validated against
// the combined checksums of the component objects.
ObjectChecksums *ObjectChecksums `protobuf:"bytes,10,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// contains filtered or unexported fields
}
Request message for [ComposeObject][google.storage.v2.Storage.ComposeObject].
func (*ComposeObjectRequest) Descriptor
deprecated
func (*ComposeObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest.ProtoReflect.Descriptor instead.
func (*ComposeObjectRequest) GetCommonObjectRequestParams ¶
func (x *ComposeObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*ComposeObjectRequest) GetDestination ¶
func (x *ComposeObjectRequest) GetDestination() *Object
func (*ComposeObjectRequest) GetDestinationPredefinedAcl ¶
func (x *ComposeObjectRequest) GetDestinationPredefinedAcl() string
func (*ComposeObjectRequest) GetIfGenerationMatch ¶
func (x *ComposeObjectRequest) GetIfGenerationMatch() int64
func (*ComposeObjectRequest) GetIfMetagenerationMatch ¶
func (x *ComposeObjectRequest) GetIfMetagenerationMatch() int64
func (*ComposeObjectRequest) GetKmsKey ¶
func (x *ComposeObjectRequest) GetKmsKey() string
func (*ComposeObjectRequest) GetObjectChecksums ¶
func (x *ComposeObjectRequest) GetObjectChecksums() *ObjectChecksums
func (*ComposeObjectRequest) GetSourceObjects ¶
func (x *ComposeObjectRequest) GetSourceObjects() []*ComposeObjectRequest_SourceObject
func (*ComposeObjectRequest) ProtoMessage ¶
func (*ComposeObjectRequest) ProtoMessage()
func (*ComposeObjectRequest) ProtoReflect ¶
func (x *ComposeObjectRequest) ProtoReflect() protoreflect.Message
func (*ComposeObjectRequest) Reset ¶
func (x *ComposeObjectRequest) Reset()
func (*ComposeObjectRequest) String ¶
func (x *ComposeObjectRequest) String() string
type ComposeObjectRequest_SourceObject ¶
type ComposeObjectRequest_SourceObject struct {
// Required. The source object's name. All source objects must reside in the
// same bucket.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The generation of this object to use as the source.
Generation int64 `protobuf:"varint,2,opt,name=generation,proto3" json:"generation,omitempty"`
// Optional. Conditions that must be met for this operation to execute.
ObjectPreconditions *ComposeObjectRequest_SourceObject_ObjectPreconditions `protobuf:"bytes,3,opt,name=object_preconditions,json=objectPreconditions,proto3" json:"object_preconditions,omitempty"`
// contains filtered or unexported fields
}
Description of a source object for a composition request.
func (*ComposeObjectRequest_SourceObject) Descriptor
deprecated
func (*ComposeObjectRequest_SourceObject) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObject.ProtoReflect.Descriptor instead.
func (*ComposeObjectRequest_SourceObject) GetGeneration ¶
func (x *ComposeObjectRequest_SourceObject) GetGeneration() int64
func (*ComposeObjectRequest_SourceObject) GetName ¶
func (x *ComposeObjectRequest_SourceObject) GetName() string
func (*ComposeObjectRequest_SourceObject) GetObjectPreconditions ¶
func (x *ComposeObjectRequest_SourceObject) GetObjectPreconditions() *ComposeObjectRequest_SourceObject_ObjectPreconditions
func (*ComposeObjectRequest_SourceObject) ProtoMessage ¶
func (*ComposeObjectRequest_SourceObject) ProtoMessage()
func (*ComposeObjectRequest_SourceObject) ProtoReflect ¶
func (x *ComposeObjectRequest_SourceObject) ProtoReflect() protoreflect.Message
func (*ComposeObjectRequest_SourceObject) Reset ¶
func (x *ComposeObjectRequest_SourceObject) Reset()
func (*ComposeObjectRequest_SourceObject) String ¶
func (x *ComposeObjectRequest_SourceObject) String() string
type ComposeObjectRequest_SourceObject_ObjectPreconditions ¶
type ComposeObjectRequest_SourceObject_ObjectPreconditions struct {
// Only perform the composition if the generation of the source object
// that would be used matches this value. If this value and a generation
// are both specified, they must be the same value or the call fails.
IfGenerationMatch *int64 `protobuf:"varint,1,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// contains filtered or unexported fields
}
Preconditions for a source object of a composition request.
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor
deprecated
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObject_ObjectPreconditions.ProtoReflect.Descriptor instead.
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch ¶
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch() int64
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage ¶
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage()
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect ¶
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect() protoreflect.Message
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset ¶
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset()
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) String ¶
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) String() string
type ContentRange ¶
type ContentRange struct {
// The starting offset of the object data. This value is inclusive.
Start int64 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
// The ending offset of the object data. This value is exclusive.
End int64 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
// The complete length of the object data.
CompleteLength int64 `protobuf:"varint,3,opt,name=complete_length,json=completeLength,proto3" json:"complete_length,omitempty"`
// contains filtered or unexported fields
}
Specifies a requested range of bytes to download.
func (*ContentRange) Descriptor
deprecated
func (*ContentRange) Descriptor() ([]byte, []int)
Deprecated: Use ContentRange.ProtoReflect.Descriptor instead.
func (*ContentRange) GetCompleteLength ¶
func (x *ContentRange) GetCompleteLength() int64
func (*ContentRange) GetEnd ¶
func (x *ContentRange) GetEnd() int64
func (*ContentRange) GetStart ¶
func (x *ContentRange) GetStart() int64
func (*ContentRange) ProtoMessage ¶
func (*ContentRange) ProtoMessage()
func (*ContentRange) ProtoReflect ¶
func (x *ContentRange) ProtoReflect() protoreflect.Message
func (*ContentRange) Reset ¶
func (x *ContentRange) Reset()
func (*ContentRange) String ¶
func (x *ContentRange) String() string
type CreateBucketRequest ¶
type CreateBucketRequest struct {
// Required. The project to which this bucket belongs. This field must either
// be empty or `projects/_`. The project ID that owns this bucket should be
// specified in the `bucket.project` field.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Properties of the new bucket being inserted.
// The name of the bucket is specified in the `bucket_id` field. Populating
// `bucket.name` field results in an error.
// The project of the bucket must be specified in the `bucket.project` field.
// This field must be in `projects/{projectIdentifier}` format,
// {projectIdentifier} can be the project ID or project number. The `parent`
// field must be either empty or `projects/_`.
Bucket *Bucket `protobuf:"bytes,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The ID to use for this bucket, which becomes the final component
// of the bucket's resource name. For example, the value `foo` might result in
// a bucket with the name `projects/123456/buckets/foo`.
BucketId string `protobuf:"bytes,3,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
// Optional. Apply a predefined set of access controls to this bucket.
// Valid values are `authenticatedRead`, `private`, `projectPrivate`,
// `publicRead`, or `publicReadWrite`.
PredefinedAcl string `protobuf:"bytes,6,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
// Optional. Apply a predefined set of default object access controls to this
// bucket. Valid values are `authenticatedRead`, `bucketOwnerFullControl`,
// `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`.
PredefinedDefaultObjectAcl string `` /* 143-byte string literal not displayed */
// Optional. If true, enable object retention on the bucket.
EnableObjectRetention bool `` /* 127-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [CreateBucket][google.storage.v2.Storage.CreateBucket].
func (*CreateBucketRequest) Descriptor
deprecated
func (*CreateBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateBucketRequest.ProtoReflect.Descriptor instead.
func (*CreateBucketRequest) GetBucket ¶
func (x *CreateBucketRequest) GetBucket() *Bucket
func (*CreateBucketRequest) GetBucketId ¶
func (x *CreateBucketRequest) GetBucketId() string
func (*CreateBucketRequest) GetEnableObjectRetention ¶ added in v1.56.0
func (x *CreateBucketRequest) GetEnableObjectRetention() bool
func (*CreateBucketRequest) GetParent ¶
func (x *CreateBucketRequest) GetParent() string
func (*CreateBucketRequest) GetPredefinedAcl ¶
func (x *CreateBucketRequest) GetPredefinedAcl() string
func (*CreateBucketRequest) GetPredefinedDefaultObjectAcl ¶
func (x *CreateBucketRequest) GetPredefinedDefaultObjectAcl() string
func (*CreateBucketRequest) ProtoMessage ¶
func (*CreateBucketRequest) ProtoMessage()
func (*CreateBucketRequest) ProtoReflect ¶
func (x *CreateBucketRequest) ProtoReflect() protoreflect.Message
func (*CreateBucketRequest) Reset ¶
func (x *CreateBucketRequest) Reset()
func (*CreateBucketRequest) String ¶
func (x *CreateBucketRequest) String() string
type CustomerEncryption ¶
type CustomerEncryption struct {
// Optional. The encryption algorithm.
EncryptionAlgorithm string `protobuf:"bytes,1,opt,name=encryption_algorithm,json=encryptionAlgorithm,proto3" json:"encryption_algorithm,omitempty"`
// Optional. SHA256 hash value of the encryption key.
// In raw bytes format (not base64-encoded).
KeySha256Bytes []byte `protobuf:"bytes,3,opt,name=key_sha256_bytes,json=keySha256Bytes,proto3" json:"key_sha256_bytes,omitempty"`
// contains filtered or unexported fields
}
Describes the customer-supplied encryption key mechanism used to store an object's data at rest.
func (*CustomerEncryption) Descriptor
deprecated
func (*CustomerEncryption) Descriptor() ([]byte, []int)
Deprecated: Use CustomerEncryption.ProtoReflect.Descriptor instead.
func (*CustomerEncryption) GetEncryptionAlgorithm ¶
func (x *CustomerEncryption) GetEncryptionAlgorithm() string
func (*CustomerEncryption) GetKeySha256Bytes ¶
func (x *CustomerEncryption) GetKeySha256Bytes() []byte
func (*CustomerEncryption) ProtoMessage ¶
func (*CustomerEncryption) ProtoMessage()
func (*CustomerEncryption) ProtoReflect ¶
func (x *CustomerEncryption) ProtoReflect() protoreflect.Message
func (*CustomerEncryption) Reset ¶
func (x *CustomerEncryption) Reset()
func (*CustomerEncryption) String ¶
func (x *CustomerEncryption) String() string
type DeleteBucketRequest ¶
type DeleteBucketRequest struct {
// Required. Name of a bucket to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// If set, only deletes the bucket if its metageneration matches this value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// If set, only deletes the bucket if its metageneration does not match this
// value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [DeleteBucket][google.storage.v2.Storage.DeleteBucket].
func (*DeleteBucketRequest) Descriptor
deprecated
func (*DeleteBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteBucketRequest.ProtoReflect.Descriptor instead.
func (*DeleteBucketRequest) GetIfMetagenerationMatch ¶
func (x *DeleteBucketRequest) GetIfMetagenerationMatch() int64
func (*DeleteBucketRequest) GetIfMetagenerationNotMatch ¶
func (x *DeleteBucketRequest) GetIfMetagenerationNotMatch() int64
func (*DeleteBucketRequest) GetName ¶
func (x *DeleteBucketRequest) GetName() string
func (*DeleteBucketRequest) ProtoMessage ¶
func (*DeleteBucketRequest) ProtoMessage()
func (*DeleteBucketRequest) ProtoReflect ¶
func (x *DeleteBucketRequest) ProtoReflect() protoreflect.Message
func (*DeleteBucketRequest) Reset ¶
func (x *DeleteBucketRequest) Reset()
func (*DeleteBucketRequest) String ¶
func (x *DeleteBucketRequest) String() string
type DeleteObjectRequest ¶
type DeleteObjectRequest struct {
// Required. Name of the bucket in which the object resides.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The name of the finalized object to delete.
// Note: If you want to delete an unfinalized resumable upload please use
// `CancelResumableWrite`.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Optional. If present, permanently deletes a specific revision of this
// object (as opposed to the latest version, the default).
Generation int64 `protobuf:"varint,4,opt,name=generation,proto3" json:"generation,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,5,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for deleting an object.
func (*DeleteObjectRequest) Descriptor
deprecated
func (*DeleteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteObjectRequest.ProtoReflect.Descriptor instead.
func (*DeleteObjectRequest) GetBucket ¶
func (x *DeleteObjectRequest) GetBucket() string
func (*DeleteObjectRequest) GetCommonObjectRequestParams ¶
func (x *DeleteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*DeleteObjectRequest) GetGeneration ¶
func (x *DeleteObjectRequest) GetGeneration() int64
func (*DeleteObjectRequest) GetIfGenerationMatch ¶
func (x *DeleteObjectRequest) GetIfGenerationMatch() int64
func (*DeleteObjectRequest) GetIfGenerationNotMatch ¶
func (x *DeleteObjectRequest) GetIfGenerationNotMatch() int64
func (*DeleteObjectRequest) GetIfMetagenerationMatch ¶
func (x *DeleteObjectRequest) GetIfMetagenerationMatch() int64
func (*DeleteObjectRequest) GetIfMetagenerationNotMatch ¶
func (x *DeleteObjectRequest) GetIfMetagenerationNotMatch() int64
func (*DeleteObjectRequest) GetObject ¶
func (x *DeleteObjectRequest) GetObject() string
func (*DeleteObjectRequest) ProtoMessage ¶
func (*DeleteObjectRequest) ProtoMessage()
func (*DeleteObjectRequest) ProtoReflect ¶
func (x *DeleteObjectRequest) ProtoReflect() protoreflect.Message
func (*DeleteObjectRequest) Reset ¶
func (x *DeleteObjectRequest) Reset()
func (*DeleteObjectRequest) String ¶
func (x *DeleteObjectRequest) String() string
type GetBucketRequest ¶
type GetBucketRequest struct {
// Required. Name of a bucket.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// If set, only gets the bucket metadata if its metageneration matches this
// value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// If set, and if the bucket's current metageneration matches the specified
// value, the request returns an error.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Mask specifying which fields to read.
// A `*` field might be used to indicate all fields.
// If no mask is specified, it defaults to all fields.
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for [GetBucket][google.storage.v2.Storage.GetBucket].
func (*GetBucketRequest) Descriptor
deprecated
func (*GetBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBucketRequest.ProtoReflect.Descriptor instead.
func (*GetBucketRequest) GetIfMetagenerationMatch ¶
func (x *GetBucketRequest) GetIfMetagenerationMatch() int64
func (*GetBucketRequest) GetIfMetagenerationNotMatch ¶
func (x *GetBucketRequest) GetIfMetagenerationNotMatch() int64
func (*GetBucketRequest) GetName ¶
func (x *GetBucketRequest) GetName() string
func (*GetBucketRequest) GetReadMask ¶
func (x *GetBucketRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*GetBucketRequest) ProtoMessage ¶
func (*GetBucketRequest) ProtoMessage()
func (*GetBucketRequest) ProtoReflect ¶
func (x *GetBucketRequest) ProtoReflect() protoreflect.Message
func (*GetBucketRequest) Reset ¶
func (x *GetBucketRequest) Reset()
func (*GetBucketRequest) String ¶
func (x *GetBucketRequest) String() string
type GetObjectRequest ¶
type GetObjectRequest struct {
// Required. Name of the bucket in which the object resides.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. Name of the object.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Optional. If present, selects a specific revision of this object (as
// opposed to the latest version, the default).
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// If true, return the soft-deleted version of this object.
SoftDeleted *bool `protobuf:"varint,11,opt,name=soft_deleted,json=softDeleted,proto3,oneof" json:"soft_deleted,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// Mask specifying which fields to read.
// If no mask is specified, it defaults to all fields except `metadata.
// acl` and `metadata.owner`.
// `*` might be used to mean "all fields".
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,10,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// Optional. Restore token used to differentiate soft-deleted objects with the
// same name and generation. Only applicable for hierarchical namespace
// buckets and if `soft_deleted` is set to `true`. This parameter is optional,
// and is only required in the rare case when there are multiple soft-deleted
// objects with the same `name` and `generation`.
RestoreToken string `protobuf:"bytes,12,opt,name=restore_token,json=restoreToken,proto3" json:"restore_token,omitempty"`
// contains filtered or unexported fields
}
Request message for [GetObject][google.storage.v2.Storage.GetObject].
func (*GetObjectRequest) Descriptor
deprecated
func (*GetObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetObjectRequest.ProtoReflect.Descriptor instead.
func (*GetObjectRequest) GetBucket ¶
func (x *GetObjectRequest) GetBucket() string
func (*GetObjectRequest) GetCommonObjectRequestParams ¶
func (x *GetObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*GetObjectRequest) GetGeneration ¶
func (x *GetObjectRequest) GetGeneration() int64
func (*GetObjectRequest) GetIfGenerationMatch ¶
func (x *GetObjectRequest) GetIfGenerationMatch() int64
func (*GetObjectRequest) GetIfGenerationNotMatch ¶
func (x *GetObjectRequest) GetIfGenerationNotMatch() int64
func (*GetObjectRequest) GetIfMetagenerationMatch ¶
func (x *GetObjectRequest) GetIfMetagenerationMatch() int64
func (*GetObjectRequest) GetIfMetagenerationNotMatch ¶
func (x *GetObjectRequest) GetIfMetagenerationNotMatch() int64
func (*GetObjectRequest) GetObject ¶
func (x *GetObjectRequest) GetObject() string
func (*GetObjectRequest) GetReadMask ¶
func (x *GetObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*GetObjectRequest) GetRestoreToken ¶ added in v1.45.0
func (x *GetObjectRequest) GetRestoreToken() string
func (*GetObjectRequest) GetSoftDeleted ¶ added in v1.34.0
func (x *GetObjectRequest) GetSoftDeleted() bool
func (*GetObjectRequest) ProtoMessage ¶
func (*GetObjectRequest) ProtoMessage()
func (*GetObjectRequest) ProtoReflect ¶
func (x *GetObjectRequest) ProtoReflect() protoreflect.Message
func (*GetObjectRequest) Reset ¶
func (x *GetObjectRequest) Reset()
func (*GetObjectRequest) String ¶
func (x *GetObjectRequest) String() string
type ListBucketsRequest ¶
type ListBucketsRequest struct {
// Required. The project whose buckets we are listing.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of buckets to return in a single response. The
// service uses this parameter or `1,000` items, whichever is smaller. If
// `acl` is present in the `read_mask`, the service uses this parameter of
// `200` items, whichever is smaller.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A previously-returned page token representing part of the larger
// set of results to view.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter results to buckets whose names begin with this prefix.
Prefix string `protobuf:"bytes,4,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Mask specifying which fields to read from each result.
// If no mask is specified, it defaults to all fields except `items.
// owner`, `items.acl`, and `items.default_object_acl`.
// `*` might be used to mean "all fields".
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// Optional. Allows listing of buckets, even if there are buckets that are
// unreachable.
ReturnPartialSuccess bool `protobuf:"varint,9,opt,name=return_partial_success,json=returnPartialSuccess,proto3" json:"return_partial_success,omitempty"`
// contains filtered or unexported fields
}
Request message for [ListBuckets][google.storage.v2.Storage.ListBuckets].
func (*ListBucketsRequest) Descriptor
deprecated
func (*ListBucketsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketsRequest.ProtoReflect.Descriptor instead.
func (*ListBucketsRequest) GetPageSize ¶
func (x *ListBucketsRequest) GetPageSize() int32
func (*ListBucketsRequest) GetPageToken ¶
func (x *ListBucketsRequest) GetPageToken() string
func (*ListBucketsRequest) GetParent ¶
func (x *ListBucketsRequest) GetParent() string
func (*ListBucketsRequest) GetPrefix ¶
func (x *ListBucketsRequest) GetPrefix() string
func (*ListBucketsRequest) GetReadMask ¶
func (x *ListBucketsRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*ListBucketsRequest) GetReturnPartialSuccess ¶ added in v1.57.2
func (x *ListBucketsRequest) GetReturnPartialSuccess() bool
func (*ListBucketsRequest) ProtoMessage ¶
func (*ListBucketsRequest) ProtoMessage()
func (*ListBucketsRequest) ProtoReflect ¶
func (x *ListBucketsRequest) ProtoReflect() protoreflect.Message
func (*ListBucketsRequest) Reset ¶
func (x *ListBucketsRequest) Reset()
func (*ListBucketsRequest) String ¶
func (x *ListBucketsRequest) String() string
type ListBucketsResponse ¶
type ListBucketsResponse struct {
// The list of items.
Buckets []*Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`
// The continuation token, used to page through large result sets. Provide
// this value in a subsequent request to return the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Unreachable resources.
// This field can only be present if the caller specified
// return_partial_success to be true in the request to receive indications
// of temporarily missing resources.
// unreachable might be:
// unreachable = [
//
// "projects/_/buckets/bucket1",
// "projects/_/buckets/bucket2",
// "projects/_/buckets/bucket3",
//
// ]
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response message for [ListBuckets][google.storage.v2.Storage.ListBuckets].
func (*ListBucketsResponse) Descriptor
deprecated
func (*ListBucketsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketsResponse.ProtoReflect.Descriptor instead.
func (*ListBucketsResponse) GetBuckets ¶
func (x *ListBucketsResponse) GetBuckets() []*Bucket
func (*ListBucketsResponse) GetNextPageToken ¶
func (x *ListBucketsResponse) GetNextPageToken() string
func (*ListBucketsResponse) GetUnreachable ¶ added in v1.57.2
func (x *ListBucketsResponse) GetUnreachable() []string
func (*ListBucketsResponse) ProtoMessage ¶
func (*ListBucketsResponse) ProtoMessage()
func (*ListBucketsResponse) ProtoReflect ¶
func (x *ListBucketsResponse) ProtoReflect() protoreflect.Message
func (*ListBucketsResponse) Reset ¶
func (x *ListBucketsResponse) Reset()
func (*ListBucketsResponse) String ¶
func (x *ListBucketsResponse) String() string
type ListObjectsRequest ¶
type ListObjectsRequest struct {
// Required. Name of the bucket in which to look for objects.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of `items` plus `prefixes` to return
// in a single page of responses. As duplicate `prefixes` are
// omitted, fewer total results might be returned than requested. The service
// uses this parameter or 1,000 items, whichever is smaller.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A previously-returned page token representing part of the larger
// set of results to view.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. If set, returns results in a directory-like mode. `items`
// contains only objects whose names, aside from the `prefix`, do not contain
// `delimiter`. Objects whose names, aside from the `prefix`, contain
// `delimiter` has their name, truncated after the `delimiter`, returned in
// `prefixes`. Duplicate `prefixes` are omitted.
Delimiter string `protobuf:"bytes,4,opt,name=delimiter,proto3" json:"delimiter,omitempty"`
// Optional. If true, objects that end in exactly one instance of `delimiter`
// has their metadata included in `items` in addition to
// `prefixes`.
IncludeTrailingDelimiter bool `` /* 136-byte string literal not displayed */
// Optional. Filter results to objects whose names begin with this prefix.
Prefix string `protobuf:"bytes,6,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Optional. If `true`, lists all versions of an object as distinct results.
Versions bool `protobuf:"varint,7,opt,name=versions,proto3" json:"versions,omitempty"`
// Mask specifying which fields to read from each result.
// If no mask is specified, defaults to all fields except `items.acl` and
// `items.owner`.
// `*` might be used to mean all fields.
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,8,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// Optional. Filter results to objects whose names are lexicographically equal
// to or after `lexicographic_start`. If `lexicographic_end` is also set, the
// objects listed have names between `lexicographic_start` (inclusive) and
// `lexicographic_end` (exclusive).
LexicographicStart string `protobuf:"bytes,10,opt,name=lexicographic_start,json=lexicographicStart,proto3" json:"lexicographic_start,omitempty"`
// Optional. Filter results to objects whose names are lexicographically
// before `lexicographic_end`. If `lexicographic_start` is also set, the
// objects listed have names between `lexicographic_start` (inclusive) and
// `lexicographic_end` (exclusive).
LexicographicEnd string `protobuf:"bytes,11,opt,name=lexicographic_end,json=lexicographicEnd,proto3" json:"lexicographic_end,omitempty"`
// Optional. If true, only list all soft-deleted versions of the object.
// Soft delete policy is required to set this option.
SoftDeleted bool `protobuf:"varint,12,opt,name=soft_deleted,json=softDeleted,proto3" json:"soft_deleted,omitempty"`
// Optional. If true, includes folders and managed folders (besides objects)
// in the returned `prefixes`. Requires `delimiter` to be set to '/'.
IncludeFoldersAsPrefixes bool `` /* 139-byte string literal not displayed */
// Optional. Filter results to objects and prefixes that match this glob
// pattern. See [List objects using
// glob](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob)
// for the full syntax.
MatchGlob string `protobuf:"bytes,14,opt,name=match_glob,json=matchGlob,proto3" json:"match_glob,omitempty"`
// Optional. An expression used to filter the returned objects by the
// `context` field. For the full syntax, see [Filter objects by contexts
// syntax](https://cloud.google.com/storage/docs/listing-objects#filter-by-object-contexts-syntax).
// If a `delimiter` is set, the returned `prefixes` are exempt from this
// filter.
Filter string `protobuf:"bytes,15,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
Request message for [ListObjects][google.storage.v2.Storage.ListObjects].
func (*ListObjectsRequest) Descriptor
deprecated
func (*ListObjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectsRequest.ProtoReflect.Descriptor instead.
func (*ListObjectsRequest) GetDelimiter ¶
func (x *ListObjectsRequest) GetDelimiter() string
func (*ListObjectsRequest) GetFilter ¶ added in v1.56.0
func (x *ListObjectsRequest) GetFilter() string
func (*ListObjectsRequest) GetIncludeFoldersAsPrefixes ¶ added in v1.39.1
func (x *ListObjectsRequest) GetIncludeFoldersAsPrefixes() bool
func (*ListObjectsRequest) GetIncludeTrailingDelimiter ¶
func (x *ListObjectsRequest) GetIncludeTrailingDelimiter() bool
func (*ListObjectsRequest) GetLexicographicEnd ¶
func (x *ListObjectsRequest) GetLexicographicEnd() string
func (*ListObjectsRequest) GetLexicographicStart ¶
func (x *ListObjectsRequest) GetLexicographicStart() string
func (*ListObjectsRequest) GetMatchGlob ¶ added in v1.34.0
func (x *ListObjectsRequest) GetMatchGlob() string
func (*ListObjectsRequest) GetPageSize ¶
func (x *ListObjectsRequest) GetPageSize() int32
func (*ListObjectsRequest) GetPageToken ¶
func (x *ListObjectsRequest) GetPageToken() string
func (*ListObjectsRequest) GetParent ¶
func (x *ListObjectsRequest) GetParent() string
func (*ListObjectsRequest) GetPrefix ¶
func (x *ListObjectsRequest) GetPrefix() string
func (*ListObjectsRequest) GetReadMask ¶
func (x *ListObjectsRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*ListObjectsRequest) GetSoftDeleted ¶ added in v1.34.0
func (x *ListObjectsRequest) GetSoftDeleted() bool
func (*ListObjectsRequest) GetVersions ¶
func (x *ListObjectsRequest) GetVersions() bool
func (*ListObjectsRequest) ProtoMessage ¶
func (*ListObjectsRequest) ProtoMessage()
func (*ListObjectsRequest) ProtoReflect ¶
func (x *ListObjectsRequest) ProtoReflect() protoreflect.Message
func (*ListObjectsRequest) Reset ¶
func (x *ListObjectsRequest) Reset()
func (*ListObjectsRequest) String ¶
func (x *ListObjectsRequest) String() string
type ListObjectsResponse ¶
type ListObjectsResponse struct {
// The list of items.
Objects []*Object `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects,omitempty"`
// The list of prefixes of objects matching-but-not-listed up to and including
// the requested delimiter.
Prefixes []string `protobuf:"bytes,2,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
// The continuation token, used to page through large result sets. Provide
// this value in a subsequent request to return the next page of results.
NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The result of a call to Objects.ListObjects
func (*ListObjectsResponse) Descriptor
deprecated
func (*ListObjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectsResponse.ProtoReflect.Descriptor instead.
func (*ListObjectsResponse) GetNextPageToken ¶
func (x *ListObjectsResponse) GetNextPageToken() string
func (*ListObjectsResponse) GetObjects ¶
func (x *ListObjectsResponse) GetObjects() []*Object
func (*ListObjectsResponse) GetPrefixes ¶
func (x *ListObjectsResponse) GetPrefixes() []string
func (*ListObjectsResponse) ProtoMessage ¶
func (*ListObjectsResponse) ProtoMessage()
func (*ListObjectsResponse) ProtoReflect ¶
func (x *ListObjectsResponse) ProtoReflect() protoreflect.Message
func (*ListObjectsResponse) Reset ¶
func (x *ListObjectsResponse) Reset()
func (*ListObjectsResponse) String ¶
func (x *ListObjectsResponse) String() string
type LockBucketRetentionPolicyRequest ¶
type LockBucketRetentionPolicyRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. Makes the operation conditional on whether bucket's current
// metageneration matches the given value. Must be positive.
IfMetagenerationMatch int64 `` /* 127-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [LockBucketRetentionPolicy][google.storage.v2.Storage.LockBucketRetentionPolicy].
func (*LockBucketRetentionPolicyRequest) Descriptor
deprecated
func (*LockBucketRetentionPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use LockBucketRetentionPolicyRequest.ProtoReflect.Descriptor instead.
func (*LockBucketRetentionPolicyRequest) GetBucket ¶
func (x *LockBucketRetentionPolicyRequest) GetBucket() string
func (*LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch ¶
func (x *LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch() int64
func (*LockBucketRetentionPolicyRequest) ProtoMessage ¶
func (*LockBucketRetentionPolicyRequest) ProtoMessage()
func (*LockBucketRetentionPolicyRequest) ProtoReflect ¶
func (x *LockBucketRetentionPolicyRequest) ProtoReflect() protoreflect.Message
func (*LockBucketRetentionPolicyRequest) Reset ¶
func (x *LockBucketRetentionPolicyRequest) Reset()
func (*LockBucketRetentionPolicyRequest) String ¶
func (x *LockBucketRetentionPolicyRequest) String() string
type MoveObjectRequest ¶ added in v1.49.0
type MoveObjectRequest struct {
// Required. Name of the bucket in which the object resides.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. Name of the source object.
SourceObject string `protobuf:"bytes,2,opt,name=source_object,json=sourceObject,proto3" json:"source_object,omitempty"`
// Required. Name of the destination object.
DestinationObject string `protobuf:"bytes,3,opt,name=destination_object,json=destinationObject,proto3" json:"destination_object,omitempty"`
// Optional. Makes the operation conditional on whether the source object's
// current generation matches the given value. `if_source_generation_match`
// and `if_source_generation_not_match` conditions are mutually exclusive:
// it's an error for both of them to be set in the request.
IfSourceGenerationMatch *int64 `` /* 141-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the source object's
// current generation does not match the given value.
// `if_source_generation_match` and `if_source_generation_not_match`
// conditions are mutually exclusive: it's an error for both of them to be set
// in the request.
IfSourceGenerationNotMatch *int64 `` /* 152-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the source object's
// current metageneration matches the given value.
// `if_source_metageneration_match` and `if_source_metageneration_not_match`
// conditions are mutually exclusive: it's an error for both of them to be set
// in the request.
IfSourceMetagenerationMatch *int64 `` /* 153-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the source object's
// current metageneration does not match the given value.
// `if_source_metageneration_match` and `if_source_metageneration_not_match`
// conditions are mutually exclusive: it's an error for both of them to be set
// in the request.
IfSourceMetagenerationNotMatch *int64 `` /* 164-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the destination
// object's current generation matches the given value. Setting to 0 makes the
// operation succeed only if there are no live versions of the object.
// `if_generation_match` and `if_generation_not_match` conditions are mutually
// exclusive: it's an error for both of them to be set in the request.
IfGenerationMatch *int64 `protobuf:"varint,8,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Optional. Makes the operation conditional on whether the destination
// object's current generation does not match the given value. If no live
// object exists, the precondition fails. Setting to 0 makes the operation
// succeed only if there is a live version of the object.
// `if_generation_match` and `if_generation_not_match` conditions are mutually
// exclusive: it's an error for both of them to be set in the request.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the destination
// object's current metageneration matches the given value.
// `if_metageneration_match` and `if_metageneration_not_match` conditions are
// mutually exclusive: it's an error for both of them to be set in the
// request.
IfMetagenerationMatch *int64 `` /* 134-byte string literal not displayed */
// Optional. Makes the operation conditional on whether the destination
// object's current metageneration does not match the given value.
// `if_metageneration_match` and `if_metageneration_not_match` conditions are
// mutually exclusive: it's an error for both of them to be set in the
// request.
IfMetagenerationNotMatch *int64 `` /* 145-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [MoveObject][google.storage.v2.Storage.MoveObject].
func (*MoveObjectRequest) Descriptor
deprecated
added in
v1.49.0
func (*MoveObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveObjectRequest.ProtoReflect.Descriptor instead.
func (*MoveObjectRequest) GetBucket ¶ added in v1.49.0
func (x *MoveObjectRequest) GetBucket() string
func (*MoveObjectRequest) GetDestinationObject ¶ added in v1.49.0
func (x *MoveObjectRequest) GetDestinationObject() string
func (*MoveObjectRequest) GetIfGenerationMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfGenerationMatch() int64
func (*MoveObjectRequest) GetIfGenerationNotMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfGenerationNotMatch() int64
func (*MoveObjectRequest) GetIfMetagenerationMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfMetagenerationMatch() int64
func (*MoveObjectRequest) GetIfMetagenerationNotMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfMetagenerationNotMatch() int64
func (*MoveObjectRequest) GetIfSourceGenerationMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfSourceGenerationMatch() int64
func (*MoveObjectRequest) GetIfSourceGenerationNotMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfSourceGenerationNotMatch() int64
func (*MoveObjectRequest) GetIfSourceMetagenerationMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfSourceMetagenerationMatch() int64
func (*MoveObjectRequest) GetIfSourceMetagenerationNotMatch ¶ added in v1.49.0
func (x *MoveObjectRequest) GetIfSourceMetagenerationNotMatch() int64
func (*MoveObjectRequest) GetSourceObject ¶ added in v1.49.0
func (x *MoveObjectRequest) GetSourceObject() string
func (*MoveObjectRequest) ProtoMessage ¶ added in v1.49.0
func (*MoveObjectRequest) ProtoMessage()
func (*MoveObjectRequest) ProtoReflect ¶ added in v1.49.0
func (x *MoveObjectRequest) ProtoReflect() protoreflect.Message
func (*MoveObjectRequest) Reset ¶ added in v1.49.0
func (x *MoveObjectRequest) Reset()
func (*MoveObjectRequest) String ¶ added in v1.49.0
func (x *MoveObjectRequest) String() string
type Object ¶
type Object struct {
// Immutable. The name of this object. Nearly any sequence of unicode
// characters is valid. See
// [Guidelines](https://cloud.google.com/storage/docs/objects#naming).
// Example: `test.txt`
// The `name` field by itself does not uniquely identify a Cloud Storage
// object. A Cloud Storage object is uniquely identified by the tuple of
// (bucket, object, generation).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The name of the bucket containing this object.
Bucket string `protobuf:"bytes,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Optional. The `etag` of an object.
// If included in the metadata of an update or delete request message, the
// operation is only performed if the etag matches that of the live
// object.
Etag string `protobuf:"bytes,27,opt,name=etag,proto3" json:"etag,omitempty"`
// Immutable. The content generation of this object. Used for object
// versioning.
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// Output only. Restore token used to differentiate deleted objects with the
// same name and generation. This field is output only, and only set for
// deleted objects in HNS buckets.
RestoreToken *string `protobuf:"bytes,35,opt,name=restore_token,json=restoreToken,proto3,oneof" json:"restore_token,omitempty"`
// Output only. The version of the metadata for this generation of this
// object. Used for preconditions and for detecting changes in metadata. A
// metageneration number is only meaningful in the context of a particular
// generation of a particular object.
Metageneration int64 `protobuf:"varint,4,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// Optional. Storage class of the object.
StorageClass string `protobuf:"bytes,5,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
// Output only. Content-Length of the object data in bytes, matching
// [RFC 7230 §3.3.2](https://tools.ietf.org/html/rfc7230#section-3.3.2]).
Size int64 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`
// Optional. Content-Encoding of the object data, matching
// [RFC 7231 §3.1.2.2](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
ContentEncoding string `protobuf:"bytes,7,opt,name=content_encoding,json=contentEncoding,proto3" json:"content_encoding,omitempty"`
// Optional. Content-Disposition of the object data, matching
// [RFC 6266](https://tools.ietf.org/html/rfc6266).
ContentDisposition string `protobuf:"bytes,8,opt,name=content_disposition,json=contentDisposition,proto3" json:"content_disposition,omitempty"`
// Optional. Cache-Control directive for the object data, matching
// [RFC 7234 §5.2](https://tools.ietf.org/html/rfc7234#section-5.2).
// If omitted, and the object is accessible to all anonymous users, the
// default is `public, max-age=3600`.
CacheControl string `protobuf:"bytes,9,opt,name=cache_control,json=cacheControl,proto3" json:"cache_control,omitempty"`
// Optional. Access controls on the object.
// If `iam_config.uniform_bucket_level_access` is enabled on the parent
// bucket, requests to set, read, or modify acl is an error.
Acl []*ObjectAccessControl `protobuf:"bytes,10,rep,name=acl,proto3" json:"acl,omitempty"`
// Optional. Content-Language of the object data, matching
// [RFC 7231 §3.1.3.2](https://tools.ietf.org/html/rfc7231#section-3.1.3.2).
ContentLanguage string `protobuf:"bytes,11,opt,name=content_language,json=contentLanguage,proto3" json:"content_language,omitempty"`
// Output only. If this object is noncurrent, this is the time when the object
// became noncurrent.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. The time when the object was finalized.
FinalizeTime *timestamppb.Timestamp `protobuf:"bytes,36,opt,name=finalize_time,json=finalizeTime,proto3" json:"finalize_time,omitempty"`
// Optional. Content-Type of the object data, matching
// [RFC 7231 §3.1.1.5](https://tools.ietf.org/html/rfc7231#section-3.1.1.5).
// If an object is stored without a Content-Type, it is served as
// `application/octet-stream`.
ContentType string `protobuf:"bytes,13,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
// Output only. The creation time of the object.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Number of underlying components that make up this object.
// Components are accumulated by compose operations.
ComponentCount int32 `protobuf:"varint,15,opt,name=component_count,json=componentCount,proto3" json:"component_count,omitempty"`
// Output only. Hashes for the data part of this object. This field is used
// for output only and is silently ignored if provided in requests. The
// checksums of the complete object regardless of data range. If the object is
// downloaded in full, the client should compute one of these checksums over
// the downloaded object and compare it against the value provided here.
Checksums *ObjectChecksums `protobuf:"bytes,16,opt,name=checksums,proto3" json:"checksums,omitempty"`
// Output only. The modification time of the object metadata.
// Set initially to object creation time and then updated whenever any
// metadata of the object changes. This includes changes made by a requester,
// such as modifying custom metadata, as well as changes made by Cloud Storage
// on behalf of a requester, such as changing the storage class based on an
// Object Lifecycle Configuration.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. Cloud KMS Key used to encrypt this object, if the object is
// encrypted by such a key.
KmsKey string `protobuf:"bytes,18,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
// Output only. The time at which the object's storage class was last changed.
// When the object is initially created, it is set to `time_created`.
UpdateStorageClassTime *timestamppb.Timestamp `` /* 132-byte string literal not displayed */
// Optional. Whether an object is under temporary hold. While this flag is set
// to true, the object is protected against deletion and overwrites. A common
// use case of this flag is regulatory investigations where objects need to be
// retained while the investigation is ongoing. Note that unlike event-based
// hold, temporary hold does not impact retention expiration time of an
// object.
TemporaryHold bool `protobuf:"varint,20,opt,name=temporary_hold,json=temporaryHold,proto3" json:"temporary_hold,omitempty"`
// Optional. A server-determined value that specifies the earliest time that
// the object's retention period expires. Note 1: This field is not provided
// for objects with an active event-based hold, since retention expiration is
// unknown until the hold is removed. Note 2: This value can be provided even
// when temporary hold is set (so that the user can reason about policy
// without having to first unset the temporary hold).
RetentionExpireTime *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=retention_expire_time,json=retentionExpireTime,proto3" json:"retention_expire_time,omitempty"`
// Optional. User-provided metadata, in key/value pairs.
Metadata map[string]string `` /* 158-byte string literal not displayed */
// Optional. User-defined or system-defined object contexts. Each object
// context is a key-payload pair, where the key provides the identification
// and the payload holds the associated value and additional metadata.
Contexts *ObjectContexts `protobuf:"bytes,38,opt,name=contexts,proto3" json:"contexts,omitempty"`
// Whether an object is under event-based hold.
// An event-based hold is a way to force the retention of an object until
// after some event occurs. Once the hold is released by explicitly setting
// this field to `false`, the object becomes subject to any bucket-level
// retention policy, except that the retention duration is calculated
// from the time the event based hold was lifted, rather than the time the
// object was created.
//
// In a `WriteObject` request, not setting this field implies that the value
// should be taken from the parent bucket's `default_event_based_hold` field.
// In a response, this field is always set to `true` or `false`.
EventBasedHold *bool `protobuf:"varint,23,opt,name=event_based_hold,json=eventBasedHold,proto3,oneof" json:"event_based_hold,omitempty"`
// Output only. The owner of the object. This is always the uploader of the
// object.
Owner *Owner `protobuf:"bytes,24,opt,name=owner,proto3" json:"owner,omitempty"`
// Optional. Metadata of customer-supplied encryption key, if the object is
// encrypted by such a key.
CustomerEncryption *CustomerEncryption `protobuf:"bytes,25,opt,name=customer_encryption,json=customerEncryption,proto3" json:"customer_encryption,omitempty"`
// Optional. A user-specified timestamp set on an object.
CustomTime *timestamppb.Timestamp `protobuf:"bytes,26,opt,name=custom_time,json=customTime,proto3" json:"custom_time,omitempty"`
// Output only. This is the time when the object became soft-deleted.
//
// Soft-deleted objects are only accessible if a soft_delete_policy is
// enabled. Also see `hard_delete_time`.
SoftDeleteTime *timestamppb.Timestamp `protobuf:"bytes,28,opt,name=soft_delete_time,json=softDeleteTime,proto3,oneof" json:"soft_delete_time,omitempty"`
// Output only. The time when the object is permanently deleted.
//
// Only set when an object becomes soft-deleted with a `soft_delete_policy`.
// Otherwise, the object is not accessible.
HardDeleteTime *timestamppb.Timestamp `protobuf:"bytes,29,opt,name=hard_delete_time,json=hardDeleteTime,proto3,oneof" json:"hard_delete_time,omitempty"`
// Optional. Retention configuration of this object.
// Might only be configured if the bucket has object retention enabled.
Retention *Object_Retention `protobuf:"bytes,30,opt,name=retention,proto3" json:"retention,omitempty"`
// contains filtered or unexported fields
}
An object.
func (*Object) Descriptor
deprecated
func (*Object) GetAcl ¶
func (x *Object) GetAcl() []*ObjectAccessControl
func (*Object) GetCacheControl ¶
func (*Object) GetChecksums ¶
func (x *Object) GetChecksums() *ObjectChecksums
func (*Object) GetComponentCount ¶
func (*Object) GetContentDisposition ¶
func (*Object) GetContentEncoding ¶
func (*Object) GetContentLanguage ¶
func (*Object) GetContentType ¶
func (*Object) GetContexts ¶ added in v1.56.0
func (x *Object) GetContexts() *ObjectContexts
func (*Object) GetCreateTime ¶
func (x *Object) GetCreateTime() *timestamppb.Timestamp
func (*Object) GetCustomTime ¶
func (x *Object) GetCustomTime() *timestamppb.Timestamp
func (*Object) GetCustomerEncryption ¶
func (x *Object) GetCustomerEncryption() *CustomerEncryption
func (*Object) GetDeleteTime ¶
func (x *Object) GetDeleteTime() *timestamppb.Timestamp
func (*Object) GetEventBasedHold ¶
func (*Object) GetFinalizeTime ¶ added in v1.49.0
func (x *Object) GetFinalizeTime() *timestamppb.Timestamp
func (*Object) GetGeneration ¶
func (*Object) GetHardDeleteTime ¶ added in v1.39.0
func (x *Object) GetHardDeleteTime() *timestamppb.Timestamp
func (*Object) GetMetadata ¶
func (*Object) GetMetageneration ¶
func (*Object) GetRestoreToken ¶ added in v1.45.0
func (*Object) GetRetention ¶ added in v1.55.0
func (x *Object) GetRetention() *Object_Retention
func (*Object) GetRetentionExpireTime ¶
func (x *Object) GetRetentionExpireTime() *timestamppb.Timestamp
func (*Object) GetSoftDeleteTime ¶ added in v1.39.0
func (x *Object) GetSoftDeleteTime() *timestamppb.Timestamp
func (*Object) GetStorageClass ¶
func (*Object) GetTemporaryHold ¶
func (*Object) GetUpdateStorageClassTime ¶
func (x *Object) GetUpdateStorageClassTime() *timestamppb.Timestamp
func (*Object) GetUpdateTime ¶
func (x *Object) GetUpdateTime() *timestamppb.Timestamp
func (*Object) ProtoMessage ¶
func (*Object) ProtoMessage()
func (*Object) ProtoReflect ¶
func (x *Object) ProtoReflect() protoreflect.Message
type ObjectAccessControl ¶
type ObjectAccessControl struct {
// Optional. The access permission for the entity. One of the following
// values:
// * `READER`
// * `WRITER`
// * `OWNER`
Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
// Optional. The ID of the access-control entry.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Optional. The entity holding the permission, in one of the following forms:
// * `user-{userid}`
// * `user-{email}`
// * `group-{groupid}`
// * `group-{email}`
// * `domain-{domain}`
// * `project-{team}-{projectnumber}`
// * `project-{team}-{projectid}`
// * `allUsers`
// * `allAuthenticatedUsers`
// Examples:
// * The user `liz@example.com` would be `user-liz@example.com`.
// * The group `example@googlegroups.com` would be
// `group-example@googlegroups.com`.
// * All members of the Google Apps for Business domain `example.com` would be
// `domain-example.com`.
// For project entities, `project-{team}-{projectnumber}` format is
// returned in the response.
Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,omitempty"`
// Output only. The alternative entity format, if exists. For project
// entities, `project-{team}-{projectid}` format is returned in the response.
EntityAlt string `protobuf:"bytes,9,opt,name=entity_alt,json=entityAlt,proto3" json:"entity_alt,omitempty"`
// Optional. The ID for the entity, if any.
EntityId string `protobuf:"bytes,4,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// Optional. The etag of the ObjectAccessControl.
// If included in the metadata of an update or delete request message, the
// operation is only performed if the etag matches that of the live
// object's ObjectAccessControl.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. The email address associated with the entity, if any.
Email string `protobuf:"bytes,5,opt,name=email,proto3" json:"email,omitempty"`
// Optional. The domain associated with the entity, if any.
Domain string `protobuf:"bytes,6,opt,name=domain,proto3" json:"domain,omitempty"`
// Optional. The project team associated with the entity, if any.
ProjectTeam *ProjectTeam `protobuf:"bytes,7,opt,name=project_team,json=projectTeam,proto3" json:"project_team,omitempty"`
// contains filtered or unexported fields
}
An access-control entry.
func (*ObjectAccessControl) Descriptor
deprecated
func (*ObjectAccessControl) Descriptor() ([]byte, []int)
Deprecated: Use ObjectAccessControl.ProtoReflect.Descriptor instead.
func (*ObjectAccessControl) GetDomain ¶
func (x *ObjectAccessControl) GetDomain() string
func (*ObjectAccessControl) GetEmail ¶
func (x *ObjectAccessControl) GetEmail() string
func (*ObjectAccessControl) GetEntity ¶
func (x *ObjectAccessControl) GetEntity() string
func (*ObjectAccessControl) GetEntityAlt ¶
func (x *ObjectAccessControl) GetEntityAlt() string
func (*ObjectAccessControl) GetEntityId ¶
func (x *ObjectAccessControl) GetEntityId() string
func (*ObjectAccessControl) GetEtag ¶
func (x *ObjectAccessControl) GetEtag() string
func (*ObjectAccessControl) GetId ¶
func (x *ObjectAccessControl) GetId() string
func (*ObjectAccessControl) GetProjectTeam ¶
func (x *ObjectAccessControl) GetProjectTeam() *ProjectTeam
func (*ObjectAccessControl) GetRole ¶
func (x *ObjectAccessControl) GetRole() string
func (*ObjectAccessControl) ProtoMessage ¶
func (*ObjectAccessControl) ProtoMessage()
func (*ObjectAccessControl) ProtoReflect ¶
func (x *ObjectAccessControl) ProtoReflect() protoreflect.Message
func (*ObjectAccessControl) Reset ¶
func (x *ObjectAccessControl) Reset()
func (*ObjectAccessControl) String ¶
func (x *ObjectAccessControl) String() string
type ObjectChecksums ¶
type ObjectChecksums struct {
// CRC32C digest of the object data. Computed by the Cloud Storage service for
// all written objects.
// If set in a WriteObjectRequest, service validates that the stored
// object matches this checksum.
Crc32C *uint32 `protobuf:"fixed32,1,opt,name=crc32c,proto3,oneof" json:"crc32c,omitempty"`
// Optional. 128 bit MD5 hash of the object data. For more information about
// using the MD5 hash, see [Data validation and change
// detection](https://cloud.google.com/storage/docs/data-validation). Not all
// objects provide an MD5 hash. For example, composite objects provide only
// crc32c hashes. This value is equivalent to running `cat object.txt |
// openssl md5 -binary`
Md5Hash []byte `protobuf:"bytes,2,opt,name=md5_hash,json=md5Hash,proto3" json:"md5_hash,omitempty"`
// contains filtered or unexported fields
}
Message used for storing full (not subrange) object checksums.
func (*ObjectChecksums) Descriptor
deprecated
func (*ObjectChecksums) Descriptor() ([]byte, []int)
Deprecated: Use ObjectChecksums.ProtoReflect.Descriptor instead.
func (*ObjectChecksums) GetCrc32C ¶
func (x *ObjectChecksums) GetCrc32C() uint32
func (*ObjectChecksums) GetMd5Hash ¶
func (x *ObjectChecksums) GetMd5Hash() []byte
func (*ObjectChecksums) ProtoMessage ¶
func (*ObjectChecksums) ProtoMessage()
func (*ObjectChecksums) ProtoReflect ¶
func (x *ObjectChecksums) ProtoReflect() protoreflect.Message
func (*ObjectChecksums) Reset ¶
func (x *ObjectChecksums) Reset()
func (*ObjectChecksums) String ¶
func (x *ObjectChecksums) String() string
type ObjectContexts ¶ added in v1.56.0
type ObjectContexts struct {
// Optional. User-defined object contexts.
Custom map[string]*ObjectCustomContextPayload `` /* 153-byte string literal not displayed */
// contains filtered or unexported fields
}
All contexts of an object grouped by type.
func (*ObjectContexts) Descriptor
deprecated
added in
v1.56.0
func (*ObjectContexts) Descriptor() ([]byte, []int)
Deprecated: Use ObjectContexts.ProtoReflect.Descriptor instead.
func (*ObjectContexts) GetCustom ¶ added in v1.56.0
func (x *ObjectContexts) GetCustom() map[string]*ObjectCustomContextPayload
func (*ObjectContexts) ProtoMessage ¶ added in v1.56.0
func (*ObjectContexts) ProtoMessage()
func (*ObjectContexts) ProtoReflect ¶ added in v1.56.0
func (x *ObjectContexts) ProtoReflect() protoreflect.Message
func (*ObjectContexts) Reset ¶ added in v1.56.0
func (x *ObjectContexts) Reset()
func (*ObjectContexts) String ¶ added in v1.56.0
func (x *ObjectContexts) String() string
type ObjectCustomContextPayload ¶ added in v1.56.0
type ObjectCustomContextPayload struct {
// Required. The value of the object context.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// Output only. The time at which the object context was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the object context was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
The payload of a single user-defined object context.
func (*ObjectCustomContextPayload) Descriptor
deprecated
added in
v1.56.0
func (*ObjectCustomContextPayload) Descriptor() ([]byte, []int)
Deprecated: Use ObjectCustomContextPayload.ProtoReflect.Descriptor instead.
func (*ObjectCustomContextPayload) GetCreateTime ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) GetCreateTime() *timestamppb.Timestamp
func (*ObjectCustomContextPayload) GetUpdateTime ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) GetUpdateTime() *timestamppb.Timestamp
func (*ObjectCustomContextPayload) GetValue ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) GetValue() string
func (*ObjectCustomContextPayload) ProtoMessage ¶ added in v1.56.0
func (*ObjectCustomContextPayload) ProtoMessage()
func (*ObjectCustomContextPayload) ProtoReflect ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) ProtoReflect() protoreflect.Message
func (*ObjectCustomContextPayload) Reset ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) Reset()
func (*ObjectCustomContextPayload) String ¶ added in v1.56.0
func (x *ObjectCustomContextPayload) String() string
type ObjectRangeData ¶ added in v1.50.0
type ObjectRangeData struct {
// A portion of the data for the object.
ChecksummedData *ChecksummedData `protobuf:"bytes,1,opt,name=checksummed_data,json=checksummedData,proto3" json:"checksummed_data,omitempty"`
// The `ReadRange` describes the content being returned with `read_id` set to
// the corresponding `ReadObjectRequest` in the stream. Multiple
// `ObjectRangeData` messages might have the same read_id but increasing
// offsets. `ReadObjectResponse` messages with the same `read_id` are
// guaranteed to be delivered in increasing offset order.
ReadRange *ReadRange `protobuf:"bytes,2,opt,name=read_range,json=readRange,proto3" json:"read_range,omitempty"`
// If set, indicates there are no more bytes to read for the given ReadRange.
RangeEnd bool `protobuf:"varint,3,opt,name=range_end,json=rangeEnd,proto3" json:"range_end,omitempty"`
// contains filtered or unexported fields
}
Contains data and metadata for a range of an object.
func (*ObjectRangeData) Descriptor
deprecated
added in
v1.50.0
func (*ObjectRangeData) Descriptor() ([]byte, []int)
Deprecated: Use ObjectRangeData.ProtoReflect.Descriptor instead.
func (*ObjectRangeData) GetChecksummedData ¶ added in v1.50.0
func (x *ObjectRangeData) GetChecksummedData() *ChecksummedData
func (*ObjectRangeData) GetRangeEnd ¶ added in v1.50.0
func (x *ObjectRangeData) GetRangeEnd() bool
func (*ObjectRangeData) GetReadRange ¶ added in v1.50.0
func (x *ObjectRangeData) GetReadRange() *ReadRange
func (*ObjectRangeData) ProtoMessage ¶ added in v1.50.0
func (*ObjectRangeData) ProtoMessage()
func (*ObjectRangeData) ProtoReflect ¶ added in v1.50.0
func (x *ObjectRangeData) ProtoReflect() protoreflect.Message
func (*ObjectRangeData) Reset ¶ added in v1.50.0
func (x *ObjectRangeData) Reset()
func (*ObjectRangeData) String ¶ added in v1.50.0
func (x *ObjectRangeData) String() string
type Object_Retention ¶ added in v1.55.0
type Object_Retention struct {
// Optional. The mode of the Retention.
Mode Object_Retention_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.storage.v2.Object_Retention_Mode" json:"mode,omitempty"`
// Optional. The timestamp that the object needs to be retained until.
// Value cannot be set in the past or more than 100 years in the future.
RetainUntilTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=retain_until_time,json=retainUntilTime,proto3" json:"retain_until_time,omitempty"`
// contains filtered or unexported fields
}
Specifies retention parameters of the object. Objects under retention cannot be deleted or overwritten until their retention expires.
func (*Object_Retention) Descriptor
deprecated
added in
v1.55.0
func (*Object_Retention) Descriptor() ([]byte, []int)
Deprecated: Use Object_Retention.ProtoReflect.Descriptor instead.
func (*Object_Retention) GetMode ¶ added in v1.55.0
func (x *Object_Retention) GetMode() Object_Retention_Mode
func (*Object_Retention) GetRetainUntilTime ¶ added in v1.55.0
func (x *Object_Retention) GetRetainUntilTime() *timestamppb.Timestamp
func (*Object_Retention) ProtoMessage ¶ added in v1.55.0
func (*Object_Retention) ProtoMessage()
func (*Object_Retention) ProtoReflect ¶ added in v1.55.0
func (x *Object_Retention) ProtoReflect() protoreflect.Message
func (*Object_Retention) Reset ¶ added in v1.55.0
func (x *Object_Retention) Reset()
func (*Object_Retention) String ¶ added in v1.55.0
func (x *Object_Retention) String() string
type Object_Retention_Mode ¶ added in v1.55.0
type Object_Retention_Mode int32
Retention mode values.
const ( // No specified mode. Object is not under retention. Object_Retention_MODE_UNSPECIFIED Object_Retention_Mode = 0 // Retention period might be decreased or increased. // The Retention configuration might be removed. // The mode might be changed to locked. Object_Retention_UNLOCKED Object_Retention_Mode = 1 // Retention period might be increased. // The Retention configuration cannot be removed. // The mode cannot be changed. Object_Retention_LOCKED Object_Retention_Mode = 2 )
func (Object_Retention_Mode) Descriptor ¶ added in v1.55.0
func (Object_Retention_Mode) Descriptor() protoreflect.EnumDescriptor
func (Object_Retention_Mode) Enum ¶ added in v1.55.0
func (x Object_Retention_Mode) Enum() *Object_Retention_Mode
func (Object_Retention_Mode) EnumDescriptor
deprecated
added in
v1.55.0
func (Object_Retention_Mode) EnumDescriptor() ([]byte, []int)
Deprecated: Use Object_Retention_Mode.Descriptor instead.
func (Object_Retention_Mode) Number ¶ added in v1.55.0
func (x Object_Retention_Mode) Number() protoreflect.EnumNumber
func (Object_Retention_Mode) String ¶ added in v1.55.0
func (x Object_Retention_Mode) String() string
func (Object_Retention_Mode) Type ¶ added in v1.55.0
func (Object_Retention_Mode) Type() protoreflect.EnumType
type Owner ¶
type Owner struct {
// Optional. The entity, in the form `user-`*userId*.
Entity string `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"`
// Optional. The ID for the entity.
EntityId string `protobuf:"bytes,2,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// contains filtered or unexported fields
}
The owner of a specific resource.
func (*Owner) Descriptor
deprecated
func (*Owner) GetEntityId ¶
func (*Owner) ProtoMessage ¶
func (*Owner) ProtoMessage()
func (*Owner) ProtoReflect ¶
func (x *Owner) ProtoReflect() protoreflect.Message
type ProjectTeam ¶
type ProjectTeam struct {
// Optional. The project number.
ProjectNumber string `protobuf:"bytes,1,opt,name=project_number,json=projectNumber,proto3" json:"project_number,omitempty"`
// Optional. The team.
Team string `protobuf:"bytes,2,opt,name=team,proto3" json:"team,omitempty"`
// contains filtered or unexported fields
}
Represents the Viewers, Editors, or Owners of a given project.
func (*ProjectTeam) Descriptor
deprecated
func (*ProjectTeam) Descriptor() ([]byte, []int)
Deprecated: Use ProjectTeam.ProtoReflect.Descriptor instead.
func (*ProjectTeam) GetProjectNumber ¶
func (x *ProjectTeam) GetProjectNumber() string
func (*ProjectTeam) GetTeam ¶
func (x *ProjectTeam) GetTeam() string
func (*ProjectTeam) ProtoMessage ¶
func (*ProjectTeam) ProtoMessage()
func (*ProjectTeam) ProtoReflect ¶
func (x *ProjectTeam) ProtoReflect() protoreflect.Message
func (*ProjectTeam) Reset ¶
func (x *ProjectTeam) Reset()
func (*ProjectTeam) String ¶
func (x *ProjectTeam) String() string
type QueryWriteStatusRequest ¶
type QueryWriteStatusRequest struct {
// Required. The name of the resume token for the object whose write status is
// being requested.
UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// contains filtered or unexported fields
}
Request object for [QueryWriteStatus][google.storage.v2.Storage.QueryWriteStatus].
func (*QueryWriteStatusRequest) Descriptor
deprecated
func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryWriteStatusRequest.ProtoReflect.Descriptor instead.
func (*QueryWriteStatusRequest) GetCommonObjectRequestParams ¶
func (x *QueryWriteStatusRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*QueryWriteStatusRequest) GetUploadId ¶
func (x *QueryWriteStatusRequest) GetUploadId() string
func (*QueryWriteStatusRequest) ProtoMessage ¶
func (*QueryWriteStatusRequest) ProtoMessage()
func (*QueryWriteStatusRequest) ProtoReflect ¶
func (x *QueryWriteStatusRequest) ProtoReflect() protoreflect.Message
func (*QueryWriteStatusRequest) Reset ¶
func (x *QueryWriteStatusRequest) Reset()
func (*QueryWriteStatusRequest) String ¶
func (x *QueryWriteStatusRequest) String() string
type QueryWriteStatusResponse ¶
type QueryWriteStatusResponse struct {
// The response sets one of the following.
//
// Types that are assignable to WriteStatus:
//
// *QueryWriteStatusResponse_PersistedSize
// *QueryWriteStatusResponse_Resource
WriteStatus isQueryWriteStatusResponse_WriteStatus `protobuf_oneof:"write_status"`
// contains filtered or unexported fields
}
Response object for [QueryWriteStatus][google.storage.v2.Storage.QueryWriteStatus].
func (*QueryWriteStatusResponse) Descriptor
deprecated
func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryWriteStatusResponse.ProtoReflect.Descriptor instead.
func (*QueryWriteStatusResponse) GetPersistedSize ¶
func (x *QueryWriteStatusResponse) GetPersistedSize() int64
func (*QueryWriteStatusResponse) GetResource ¶
func (x *QueryWriteStatusResponse) GetResource() *Object
func (*QueryWriteStatusResponse) GetWriteStatus ¶
func (m *QueryWriteStatusResponse) GetWriteStatus() isQueryWriteStatusResponse_WriteStatus
func (*QueryWriteStatusResponse) ProtoMessage ¶
func (*QueryWriteStatusResponse) ProtoMessage()
func (*QueryWriteStatusResponse) ProtoReflect ¶
func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message
func (*QueryWriteStatusResponse) Reset ¶
func (x *QueryWriteStatusResponse) Reset()
func (*QueryWriteStatusResponse) String ¶
func (x *QueryWriteStatusResponse) String() string
type QueryWriteStatusResponse_PersistedSize ¶
type QueryWriteStatusResponse_PersistedSize struct {
// The total number of bytes that have been processed for the given object
// from all `WriteObject` calls. This is the correct value for the
// 'write_offset' field to use when resuming the `WriteObject` operation.
// Only set if the upload has not finalized.
PersistedSize int64 `protobuf:"varint,1,opt,name=persisted_size,json=persistedSize,proto3,oneof"`
}
type QueryWriteStatusResponse_Resource ¶
type QueryWriteStatusResponse_Resource struct {
// A resource containing the metadata for the uploaded object. Only set if
// the upload has finalized.
Resource *Object `protobuf:"bytes,2,opt,name=resource,proto3,oneof"`
}
type ReadObjectRequest ¶
type ReadObjectRequest struct {
// Required. The name of the bucket containing the object to read.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The name of the object to read.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Optional. If present, selects a specific revision of this object (as
// opposed to the latest version, the default).
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// Optional. The offset for the first byte to return in the read, relative to
// the start of the object.
//
// A negative `read_offset` value is interpreted as the number of bytes
// back from the end of the object to be returned. For example, if an object's
// length is `15` bytes, a `ReadObjectRequest` with `read_offset` = `-5` and
// `read_limit` = `3` would return bytes `10` through `12` of the object.
// Requesting a negative offset with magnitude larger than the size of the
// object returns the entire object.
ReadOffset int64 `protobuf:"varint,4,opt,name=read_offset,json=readOffset,proto3" json:"read_offset,omitempty"`
// Optional. The maximum number of `data` bytes the server is allowed to
// return in the sum of all `Object` messages. A `read_limit` of zero
// indicates that there is no limit, and a negative `read_limit` causes an
// error.
//
// If the stream returns fewer bytes than allowed by the `read_limit` and no
// error occurred, the stream includes all data from the `read_offset` to the
// end of the resource.
ReadLimit int64 `protobuf:"varint,5,opt,name=read_limit,json=readLimit,proto3" json:"read_limit,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,6,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
// Mask specifying which fields to read.
// The `checksummed_data` field and its children are always present.
// If no mask is specified, it defaults to all fields except `metadata.
// owner` and `metadata.acl`.
// `*` might be used to mean "all fields".
ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,12,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for [ReadObject][google.storage.v2.Storage.ReadObject].
func (*ReadObjectRequest) Descriptor
deprecated
func (*ReadObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReadObjectRequest.ProtoReflect.Descriptor instead.
func (*ReadObjectRequest) GetBucket ¶
func (x *ReadObjectRequest) GetBucket() string
func (*ReadObjectRequest) GetCommonObjectRequestParams ¶
func (x *ReadObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*ReadObjectRequest) GetGeneration ¶
func (x *ReadObjectRequest) GetGeneration() int64
func (*ReadObjectRequest) GetIfGenerationMatch ¶
func (x *ReadObjectRequest) GetIfGenerationMatch() int64
func (*ReadObjectRequest) GetIfGenerationNotMatch ¶
func (x *ReadObjectRequest) GetIfGenerationNotMatch() int64
func (*ReadObjectRequest) GetIfMetagenerationMatch ¶
func (x *ReadObjectRequest) GetIfMetagenerationMatch() int64
func (*ReadObjectRequest) GetIfMetagenerationNotMatch ¶
func (x *ReadObjectRequest) GetIfMetagenerationNotMatch() int64
func (*ReadObjectRequest) GetObject ¶
func (x *ReadObjectRequest) GetObject() string
func (*ReadObjectRequest) GetReadLimit ¶
func (x *ReadObjectRequest) GetReadLimit() int64
func (*ReadObjectRequest) GetReadMask ¶
func (x *ReadObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*ReadObjectRequest) GetReadOffset ¶
func (x *ReadObjectRequest) GetReadOffset() int64
func (*ReadObjectRequest) ProtoMessage ¶
func (*ReadObjectRequest) ProtoMessage()
func (*ReadObjectRequest) ProtoReflect ¶
func (x *ReadObjectRequest) ProtoReflect() protoreflect.Message
func (*ReadObjectRequest) Reset ¶
func (x *ReadObjectRequest) Reset()
func (*ReadObjectRequest) String ¶
func (x *ReadObjectRequest) String() string
type ReadObjectResponse ¶
type ReadObjectResponse struct {
// A portion of the data for the object. The service might leave `data`
// empty for any given `ReadResponse`. This enables the service to inform the
// client that the request is still live while it is running an operation to
// generate more data.
ChecksummedData *ChecksummedData `protobuf:"bytes,1,opt,name=checksummed_data,json=checksummedData,proto3" json:"checksummed_data,omitempty"`
// The checksums of the complete object. If the object is downloaded in full,
// the client should compute one of these checksums over the downloaded object
// and compare it against the value provided here.
ObjectChecksums *ObjectChecksums `protobuf:"bytes,2,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// If `read_offset` and or `read_limit` is specified on the
// `ReadObjectRequest`, `ContentRange` is populated on the first
// `ReadObjectResponse` message of the read stream.
ContentRange *ContentRange `protobuf:"bytes,3,opt,name=content_range,json=contentRange,proto3" json:"content_range,omitempty"`
// Metadata of the object whose media is being returned.
// Only populated in the first response in the stream.
Metadata *Object `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
Response message for [ReadObject][google.storage.v2.Storage.ReadObject].
func (*ReadObjectResponse) Descriptor
deprecated
func (*ReadObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReadObjectResponse.ProtoReflect.Descriptor instead.
func (*ReadObjectResponse) GetChecksummedData ¶
func (x *ReadObjectResponse) GetChecksummedData() *ChecksummedData
func (*ReadObjectResponse) GetContentRange ¶
func (x *ReadObjectResponse) GetContentRange() *ContentRange
func (*ReadObjectResponse) GetMetadata ¶
func (x *ReadObjectResponse) GetMetadata() *Object
func (*ReadObjectResponse) GetObjectChecksums ¶
func (x *ReadObjectResponse) GetObjectChecksums() *ObjectChecksums
func (*ReadObjectResponse) ProtoMessage ¶
func (*ReadObjectResponse) ProtoMessage()
func (*ReadObjectResponse) ProtoReflect ¶
func (x *ReadObjectResponse) ProtoReflect() protoreflect.Message
func (*ReadObjectResponse) Reset ¶
func (x *ReadObjectResponse) Reset()
func (*ReadObjectResponse) String ¶
func (x *ReadObjectResponse) String() string
type ReadRange ¶ added in v1.50.0
type ReadRange struct {
// Required. The offset for the first byte to return in the read, relative to
// the start of the object.
//
// A negative read_offset value is interpreted as the number of bytes
// back from the end of the object to be returned. For example, if an object's
// length is 15 bytes, a `ReadObjectRequest` with `read_offset` = -5 and
// `read_length` = 3 would return bytes 10 through 12 of the object.
// Requesting a negative offset with magnitude larger than the size of the
// object returns the entire object. A `read_offset` larger than the size
// of the object results in an `OutOfRange` error.
ReadOffset int64 `protobuf:"varint,1,opt,name=read_offset,json=readOffset,proto3" json:"read_offset,omitempty"`
// Optional. The maximum number of data bytes the server is allowed to return
// across all response messages with the same `read_id`. A `read_length` of
// zero indicates to read until the resource end, and a negative `read_length`
// causes an error. If the stream returns fewer bytes than allowed by the
// `read_length` and no error occurred, the stream includes all data from the
// `read_offset` to the resource end.
ReadLength int64 `protobuf:"varint,2,opt,name=read_length,json=readLength,proto3" json:"read_length,omitempty"`
// Required. Read identifier provided by the client. When the client issues
// more than one outstanding `ReadRange` on the same stream, responses can be
// mapped back to their corresponding requests using this value. Clients must
// ensure that all outstanding requests have different read_id values. The
// server might close the stream with an error if this condition is not met.
ReadId int64 `protobuf:"varint,3,opt,name=read_id,json=readId,proto3" json:"read_id,omitempty"`
// contains filtered or unexported fields
}
Describes a range of bytes to read in a `BidiReadObjectRanges` request.
func (*ReadRange) Descriptor
deprecated
added in
v1.50.0
func (*ReadRange) GetReadLength ¶ added in v1.50.0
func (*ReadRange) GetReadOffset ¶ added in v1.50.0
func (*ReadRange) ProtoMessage ¶ added in v1.50.0
func (*ReadRange) ProtoMessage()
func (*ReadRange) ProtoReflect ¶ added in v1.50.0
func (x *ReadRange) ProtoReflect() protoreflect.Message
type ReadRangeError ¶ added in v1.50.0
type ReadRangeError struct {
// The id of the corresponding read_range
ReadId int64 `protobuf:"varint,1,opt,name=read_id,json=readId,proto3" json:"read_id,omitempty"`
// The status which should be an enum value of [google.rpc.Code].
Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
// contains filtered or unexported fields
}
Error extension proto containing details for a single range read
func (*ReadRangeError) Descriptor
deprecated
added in
v1.50.0
func (*ReadRangeError) Descriptor() ([]byte, []int)
Deprecated: Use ReadRangeError.ProtoReflect.Descriptor instead.
func (*ReadRangeError) GetReadId ¶ added in v1.50.0
func (x *ReadRangeError) GetReadId() int64
func (*ReadRangeError) GetStatus ¶ added in v1.50.0
func (x *ReadRangeError) GetStatus() *status.Status
func (*ReadRangeError) ProtoMessage ¶ added in v1.50.0
func (*ReadRangeError) ProtoMessage()
func (*ReadRangeError) ProtoReflect ¶ added in v1.50.0
func (x *ReadRangeError) ProtoReflect() protoreflect.Message
func (*ReadRangeError) Reset ¶ added in v1.50.0
func (x *ReadRangeError) Reset()
func (*ReadRangeError) String ¶ added in v1.50.0
func (x *ReadRangeError) String() string
type RestoreObjectRequest ¶ added in v1.34.0
type RestoreObjectRequest struct {
// Required. Name of the bucket in which the object resides.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The name of the object to restore.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Required. The specific revision of the object to restore.
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// Optional. Restore token used to differentiate soft-deleted objects with the
// same name and generation. Only applicable for hierarchical namespace
// buckets. This parameter is optional, and is only required in the rare case
// when there are multiple soft-deleted objects with the same name and
// generation.
RestoreToken string `protobuf:"bytes,11,opt,name=restore_token,json=restoreToken,proto3" json:"restore_token,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// If false or unset, the bucket's default object ACL is used.
// If true, copy the source object's access controls.
// Return an error if bucket has UBLA enabled.
CopySourceAcl *bool `protobuf:"varint,9,opt,name=copy_source_acl,json=copySourceAcl,proto3,oneof" json:"copy_source_acl,omitempty"`
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [RestoreObject][google.storage.v2.Storage.RestoreObject]. `bucket`, `object`, and `generation` **must** be set.
func (*RestoreObjectRequest) Descriptor
deprecated
added in
v1.34.0
func (*RestoreObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use RestoreObjectRequest.ProtoReflect.Descriptor instead.
func (*RestoreObjectRequest) GetBucket ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetBucket() string
func (*RestoreObjectRequest) GetCommonObjectRequestParams ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*RestoreObjectRequest) GetCopySourceAcl ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetCopySourceAcl() bool
func (*RestoreObjectRequest) GetGeneration ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetGeneration() int64
func (*RestoreObjectRequest) GetIfGenerationMatch ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetIfGenerationMatch() int64
func (*RestoreObjectRequest) GetIfGenerationNotMatch ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetIfGenerationNotMatch() int64
func (*RestoreObjectRequest) GetIfMetagenerationMatch ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetIfMetagenerationMatch() int64
func (*RestoreObjectRequest) GetIfMetagenerationNotMatch ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetIfMetagenerationNotMatch() int64
func (*RestoreObjectRequest) GetObject ¶ added in v1.34.0
func (x *RestoreObjectRequest) GetObject() string
func (*RestoreObjectRequest) GetRestoreToken ¶ added in v1.45.0
func (x *RestoreObjectRequest) GetRestoreToken() string
func (*RestoreObjectRequest) ProtoMessage ¶ added in v1.34.0
func (*RestoreObjectRequest) ProtoMessage()
func (*RestoreObjectRequest) ProtoReflect ¶ added in v1.34.0
func (x *RestoreObjectRequest) ProtoReflect() protoreflect.Message
func (*RestoreObjectRequest) Reset ¶ added in v1.34.0
func (x *RestoreObjectRequest) Reset()
func (*RestoreObjectRequest) String ¶ added in v1.34.0
func (x *RestoreObjectRequest) String() string
type RewriteObjectRequest ¶
type RewriteObjectRequest struct {
// Required. Immutable. The name of the destination object.
// See the
// [Naming Guidelines](https://cloud.google.com/storage/docs/objects#naming).
// Example: `test.txt`
// The `name` field by itself does not uniquely identify a Cloud Storage
// object. A Cloud Storage object is uniquely identified by the tuple of
// (bucket, object, generation).
DestinationName string `protobuf:"bytes,24,opt,name=destination_name,json=destinationName,proto3" json:"destination_name,omitempty"`
// Required. Immutable. The name of the bucket containing the destination
// object.
DestinationBucket string `protobuf:"bytes,25,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
// Optional. The name of the Cloud KMS key that is used to encrypt the
// destination object. The Cloud KMS key must be located in same location as
// the object. If the parameter is not specified, the request uses the
// destination bucket's default encryption key, if any, or else the
// Google-managed encryption key.
DestinationKmsKey string `protobuf:"bytes,27,opt,name=destination_kms_key,json=destinationKmsKey,proto3" json:"destination_kms_key,omitempty"`
// Optional. Properties of the destination, post-rewrite object.
// The `name`, `bucket` and `kms_key` fields must not be populated (these
// values are specified in the `destination_name`, `destination_bucket`, and
// `destination_kms_key` fields).
// If `destination` is present it is used to construct the destination
// object's metadata; otherwise the destination object's metadata is
// copied from the source object.
Destination *Object `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
// Required. Name of the bucket in which to find the source object.
SourceBucket string `protobuf:"bytes,2,opt,name=source_bucket,json=sourceBucket,proto3" json:"source_bucket,omitempty"`
// Required. Name of the source object.
SourceObject string `protobuf:"bytes,3,opt,name=source_object,json=sourceObject,proto3" json:"source_object,omitempty"`
// Optional. If present, selects a specific revision of the source object (as
// opposed to the latest version, the default).
SourceGeneration int64 `protobuf:"varint,4,opt,name=source_generation,json=sourceGeneration,proto3" json:"source_generation,omitempty"`
// Optional. Include this field (from the previous rewrite response) on each
// rewrite request after the first one, until the rewrite response 'done' flag
// is true. Calls that provide a rewriteToken can omit all other request
// fields, but if included those fields must match the values provided in the
// first rewrite request.
RewriteToken string `protobuf:"bytes,5,opt,name=rewrite_token,json=rewriteToken,proto3" json:"rewrite_token,omitempty"`
// Optional. Apply a predefined set of access controls to the destination
// object. Valid values are `authenticatedRead`, `bucketOwnerFullControl`,
// `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`.
DestinationPredefinedAcl string `` /* 136-byte string literal not displayed */
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,7,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the destination object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the destination object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 145-byte string literal not displayed */
// Makes the operation conditional on whether the source object's live
// generation matches the given value.
IfSourceGenerationMatch *int64 `` /* 142-byte string literal not displayed */
// Makes the operation conditional on whether the source object's live
// generation does not match the given value.
IfSourceGenerationNotMatch *int64 `` /* 153-byte string literal not displayed */
// Makes the operation conditional on whether the source object's current
// metageneration matches the given value.
IfSourceMetagenerationMatch *int64 `` /* 154-byte string literal not displayed */
// Makes the operation conditional on whether the source object's current
// metageneration does not match the given value.
IfSourceMetagenerationNotMatch *int64 `` /* 165-byte string literal not displayed */
// Optional. The maximum number of bytes that are rewritten per rewrite
// request. Most callers shouldn't need to specify this parameter - it is
// primarily in place to support testing. If specified the value must be an
// integral multiple of 1 MiB (1048576). Also, this only applies to requests
// where the source and destination span locations and/or storage classes.
// Finally, this value must not change across rewrite calls else you'll get an
// error that the `rewriteToken` is invalid.
MaxBytesRewrittenPerCall int64 `` /* 141-byte string literal not displayed */
// Optional. The algorithm used to encrypt the source object, if any. Used if
// the source object was encrypted with a Customer-Supplied Encryption Key.
CopySourceEncryptionAlgorithm string `` /* 153-byte string literal not displayed */
// Optional. The raw bytes (not base64-encoded) AES-256 encryption key used to
// encrypt the source object, if it was encrypted with a Customer-Supplied
// Encryption Key.
CopySourceEncryptionKeyBytes []byte `` /* 152-byte string literal not displayed */
// Optional. The raw bytes (not base64-encoded) SHA256 hash of the encryption
// key used to encrypt the source object, if it was encrypted with a
// Customer-Supplied Encryption Key.
CopySourceEncryptionKeySha256Bytes []byte `` /* 172-byte string literal not displayed */
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
// Optional. The checksums of the complete object. This is used to validate
// the destination object after rewriting.
ObjectChecksums *ObjectChecksums `protobuf:"bytes,29,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// contains filtered or unexported fields
}
Request message for [RewriteObject][google.storage.v2.Storage.RewriteObject]. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the `copy_source_encryption_algorithm`, `copy_source_encryption_key_bytes`, and `copy_source_encryption_key_sha256_bytes` fields. If the destination object should be encrypted the keying information should be provided in the `encryption_algorithm`, `encryption_key_bytes`, and `encryption_key_sha256_bytes` fields of the `common_object_request_params.customer_encryption` field.
func (*RewriteObjectRequest) Descriptor
deprecated
func (*RewriteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use RewriteObjectRequest.ProtoReflect.Descriptor instead.
func (*RewriteObjectRequest) GetCommonObjectRequestParams ¶
func (x *RewriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*RewriteObjectRequest) GetCopySourceEncryptionAlgorithm ¶
func (x *RewriteObjectRequest) GetCopySourceEncryptionAlgorithm() string
func (*RewriteObjectRequest) GetCopySourceEncryptionKeyBytes ¶
func (x *RewriteObjectRequest) GetCopySourceEncryptionKeyBytes() []byte
func (*RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes ¶
func (x *RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes() []byte
func (*RewriteObjectRequest) GetDestination ¶
func (x *RewriteObjectRequest) GetDestination() *Object
func (*RewriteObjectRequest) GetDestinationBucket ¶
func (x *RewriteObjectRequest) GetDestinationBucket() string
func (*RewriteObjectRequest) GetDestinationKmsKey ¶
func (x *RewriteObjectRequest) GetDestinationKmsKey() string
func (*RewriteObjectRequest) GetDestinationName ¶
func (x *RewriteObjectRequest) GetDestinationName() string
func (*RewriteObjectRequest) GetDestinationPredefinedAcl ¶
func (x *RewriteObjectRequest) GetDestinationPredefinedAcl() string
func (*RewriteObjectRequest) GetIfGenerationMatch ¶
func (x *RewriteObjectRequest) GetIfGenerationMatch() int64
func (*RewriteObjectRequest) GetIfGenerationNotMatch ¶
func (x *RewriteObjectRequest) GetIfGenerationNotMatch() int64
func (*RewriteObjectRequest) GetIfMetagenerationMatch ¶
func (x *RewriteObjectRequest) GetIfMetagenerationMatch() int64
func (*RewriteObjectRequest) GetIfMetagenerationNotMatch ¶
func (x *RewriteObjectRequest) GetIfMetagenerationNotMatch() int64
func (*RewriteObjectRequest) GetIfSourceGenerationMatch ¶
func (x *RewriteObjectRequest) GetIfSourceGenerationMatch() int64
func (*RewriteObjectRequest) GetIfSourceGenerationNotMatch ¶
func (x *RewriteObjectRequest) GetIfSourceGenerationNotMatch() int64
func (*RewriteObjectRequest) GetIfSourceMetagenerationMatch ¶
func (x *RewriteObjectRequest) GetIfSourceMetagenerationMatch() int64
func (*RewriteObjectRequest) GetIfSourceMetagenerationNotMatch ¶
func (x *RewriteObjectRequest) GetIfSourceMetagenerationNotMatch() int64
func (*RewriteObjectRequest) GetMaxBytesRewrittenPerCall ¶
func (x *RewriteObjectRequest) GetMaxBytesRewrittenPerCall() int64
func (*RewriteObjectRequest) GetObjectChecksums ¶
func (x *RewriteObjectRequest) GetObjectChecksums() *ObjectChecksums
func (*RewriteObjectRequest) GetRewriteToken ¶
func (x *RewriteObjectRequest) GetRewriteToken() string
func (*RewriteObjectRequest) GetSourceBucket ¶
func (x *RewriteObjectRequest) GetSourceBucket() string
func (*RewriteObjectRequest) GetSourceGeneration ¶
func (x *RewriteObjectRequest) GetSourceGeneration() int64
func (*RewriteObjectRequest) GetSourceObject ¶
func (x *RewriteObjectRequest) GetSourceObject() string
func (*RewriteObjectRequest) ProtoMessage ¶
func (*RewriteObjectRequest) ProtoMessage()
func (*RewriteObjectRequest) ProtoReflect ¶
func (x *RewriteObjectRequest) ProtoReflect() protoreflect.Message
func (*RewriteObjectRequest) Reset ¶
func (x *RewriteObjectRequest) Reset()
func (*RewriteObjectRequest) String ¶
func (x *RewriteObjectRequest) String() string
type RewriteResponse ¶
type RewriteResponse struct {
// The total bytes written so far, which can be used to provide a waiting user
// with a progress indicator. This property is always present in the response.
TotalBytesRewritten int64 `protobuf:"varint,1,opt,name=total_bytes_rewritten,json=totalBytesRewritten,proto3" json:"total_bytes_rewritten,omitempty"`
// The total size of the object being copied in bytes. This property is always
// present in the response.
ObjectSize int64 `protobuf:"varint,2,opt,name=object_size,json=objectSize,proto3" json:"object_size,omitempty"`
// `true` if the copy is finished; otherwise, `false` if
// the copy is in progress. This property is always present in the response.
Done bool `protobuf:"varint,3,opt,name=done,proto3" json:"done,omitempty"`
// A token to use in subsequent requests to continue copying data. This token
// is present in the response only when there is more data to copy.
RewriteToken string `protobuf:"bytes,4,opt,name=rewrite_token,json=rewriteToken,proto3" json:"rewrite_token,omitempty"`
// A resource containing the metadata for the copied-to object. This property
// is present in the response only when copying completes.
Resource *Object `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`
// contains filtered or unexported fields
}
A rewrite response.
func (*RewriteResponse) Descriptor
deprecated
func (*RewriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use RewriteResponse.ProtoReflect.Descriptor instead.
func (*RewriteResponse) GetDone ¶
func (x *RewriteResponse) GetDone() bool
func (*RewriteResponse) GetObjectSize ¶
func (x *RewriteResponse) GetObjectSize() int64
func (*RewriteResponse) GetResource ¶
func (x *RewriteResponse) GetResource() *Object
func (*RewriteResponse) GetRewriteToken ¶
func (x *RewriteResponse) GetRewriteToken() string
func (*RewriteResponse) GetTotalBytesRewritten ¶
func (x *RewriteResponse) GetTotalBytesRewritten() int64
func (*RewriteResponse) ProtoMessage ¶
func (*RewriteResponse) ProtoMessage()
func (*RewriteResponse) ProtoReflect ¶
func (x *RewriteResponse) ProtoReflect() protoreflect.Message
func (*RewriteResponse) Reset ¶
func (x *RewriteResponse) Reset()
func (*RewriteResponse) String ¶
func (x *RewriteResponse) String() string
type ServiceConstants ¶
type ServiceConstants struct {
// contains filtered or unexported fields
}
Shared constants.
func (*ServiceConstants) Descriptor
deprecated
func (*ServiceConstants) Descriptor() ([]byte, []int)
Deprecated: Use ServiceConstants.ProtoReflect.Descriptor instead.
func (*ServiceConstants) ProtoMessage ¶
func (*ServiceConstants) ProtoMessage()
func (*ServiceConstants) ProtoReflect ¶
func (x *ServiceConstants) ProtoReflect() protoreflect.Message
func (*ServiceConstants) Reset ¶
func (x *ServiceConstants) Reset()
func (*ServiceConstants) String ¶
func (x *ServiceConstants) String() string
type ServiceConstants_Values ¶
type ServiceConstants_Values int32
A collection of constant values meaningful to the Storage API.
const ( // Unused. Proto3 requires first enum to be 0. ServiceConstants_VALUES_UNSPECIFIED ServiceConstants_Values = 0 // The maximum size chunk that can be returned in a single // `ReadRequest`. // 2 MiB. ServiceConstants_MAX_READ_CHUNK_BYTES ServiceConstants_Values = 2097152 // The maximum size chunk that can be sent in a single WriteObjectRequest. // 2 MiB. ServiceConstants_MAX_WRITE_CHUNK_BYTES ServiceConstants_Values = 2097152 // The maximum size of an object in MB - whether written in a single stream // or composed from multiple other objects. // 5 TiB. ServiceConstants_MAX_OBJECT_SIZE_MB ServiceConstants_Values = 5242880 // The maximum length field name that can be sent in a single // custom metadata field. // 1 KiB. ServiceConstants_MAX_CUSTOM_METADATA_FIELD_NAME_BYTES ServiceConstants_Values = 1024 // The maximum length field value that can be sent in a single // custom_metadata field. // 4 KiB. ServiceConstants_MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES ServiceConstants_Values = 4096 // The maximum total bytes that can be populated into all field names and // values of the custom_metadata for one object. // 8 KiB. ServiceConstants_MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES ServiceConstants_Values = 8192 // The maximum total bytes that can be populated into all bucket metadata // fields. // 20 KiB. ServiceConstants_MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES ServiceConstants_Values = 20480 // The maximum number of NotificationConfigs that can be registered // for a given bucket. ServiceConstants_MAX_NOTIFICATION_CONFIGS_PER_BUCKET ServiceConstants_Values = 100 // The maximum number of LifecycleRules that can be registered for a given // bucket. ServiceConstants_MAX_LIFECYCLE_RULES_PER_BUCKET ServiceConstants_Values = 100 // The maximum number of custom attributes per NotificationConfigs. ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTES ServiceConstants_Values = 5 // The maximum length of a custom attribute key included in // NotificationConfig. ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH ServiceConstants_Values = 256 // The maximum length of a custom attribute value included in a // NotificationConfig. ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_VALUE_LENGTH ServiceConstants_Values = 1024 // The maximum number of key/value entries per bucket label. ServiceConstants_MAX_LABELS_ENTRIES_COUNT ServiceConstants_Values = 64 // The maximum character length of the key or value in a bucket // label map. ServiceConstants_MAX_LABELS_KEY_VALUE_LENGTH ServiceConstants_Values = 63 // The maximum byte size of the key or value in a bucket label // map. ServiceConstants_MAX_LABELS_KEY_VALUE_BYTES ServiceConstants_Values = 128 // The maximum number of object IDs that can be included in a // DeleteObjectsRequest. ServiceConstants_MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST ServiceConstants_Values = 1000 // The maximum number of days for which a token returned by the // GetListObjectsSplitPoints RPC is valid. ServiceConstants_SPLIT_TOKEN_MAX_VALID_DAYS ServiceConstants_Values = 14 )
func (ServiceConstants_Values) Descriptor ¶
func (ServiceConstants_Values) Descriptor() protoreflect.EnumDescriptor
func (ServiceConstants_Values) Enum ¶
func (x ServiceConstants_Values) Enum() *ServiceConstants_Values
func (ServiceConstants_Values) EnumDescriptor
deprecated
func (ServiceConstants_Values) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceConstants_Values.Descriptor instead.
func (ServiceConstants_Values) Number ¶
func (x ServiceConstants_Values) Number() protoreflect.EnumNumber
func (ServiceConstants_Values) String ¶
func (x ServiceConstants_Values) String() string
func (ServiceConstants_Values) Type ¶
func (ServiceConstants_Values) Type() protoreflect.EnumType
type StartResumableWriteRequest ¶
type StartResumableWriteRequest struct {
// Required. Contains the information necessary to start a resumable write.
WriteObjectSpec *WriteObjectSpec `protobuf:"bytes,1,opt,name=write_object_spec,json=writeObjectSpec,proto3" json:"write_object_spec,omitempty"`
// Optional. A set of parameters common to Storage API requests related to an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// Optional. The checksums of the complete object. This is used to validate
// the uploaded object. For each upload, `object_checksums` can be provided
// when initiating a resumable upload with`StartResumableWriteRequest` or when
// completing a write with `WriteObjectRequest` with
// `finish_write` set to `true`.
ObjectChecksums *ObjectChecksums `protobuf:"bytes,5,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// contains filtered or unexported fields
}
Request message for [StartResumableWrite][google.storage.v2.Storage.StartResumableWrite].
func (*StartResumableWriteRequest) Descriptor
deprecated
func (*StartResumableWriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartResumableWriteRequest.ProtoReflect.Descriptor instead.
func (*StartResumableWriteRequest) GetCommonObjectRequestParams ¶
func (x *StartResumableWriteRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*StartResumableWriteRequest) GetObjectChecksums ¶
func (x *StartResumableWriteRequest) GetObjectChecksums() *ObjectChecksums
func (*StartResumableWriteRequest) GetWriteObjectSpec ¶
func (x *StartResumableWriteRequest) GetWriteObjectSpec() *WriteObjectSpec
func (*StartResumableWriteRequest) ProtoMessage ¶
func (*StartResumableWriteRequest) ProtoMessage()
func (*StartResumableWriteRequest) ProtoReflect ¶
func (x *StartResumableWriteRequest) ProtoReflect() protoreflect.Message
func (*StartResumableWriteRequest) Reset ¶
func (x *StartResumableWriteRequest) Reset()
func (*StartResumableWriteRequest) String ¶
func (x *StartResumableWriteRequest) String() string
type StartResumableWriteResponse ¶
type StartResumableWriteResponse struct {
// A unique identifier for the initiated resumable write operation.
// As the ID grants write access, you should keep it confidential during
// the upload to prevent unauthorized access and data tampering during your
// upload. This ID should be included in subsequent `WriteObject` requests to
// upload the object data.
UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
// contains filtered or unexported fields
}
Response object for [StartResumableWrite][google.storage.v2.Storage.StartResumableWrite].
func (*StartResumableWriteResponse) Descriptor
deprecated
func (*StartResumableWriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use StartResumableWriteResponse.ProtoReflect.Descriptor instead.
func (*StartResumableWriteResponse) GetUploadId ¶
func (x *StartResumableWriteResponse) GetUploadId() string
func (*StartResumableWriteResponse) ProtoMessage ¶
func (*StartResumableWriteResponse) ProtoMessage()
func (*StartResumableWriteResponse) ProtoReflect ¶
func (x *StartResumableWriteResponse) ProtoReflect() protoreflect.Message
func (*StartResumableWriteResponse) Reset ¶
func (x *StartResumableWriteResponse) Reset()
func (*StartResumableWriteResponse) String ¶
func (x *StartResumableWriteResponse) String() string
type StorageClient ¶
type StorageClient interface {
// Permanently deletes an empty bucket.
// The request fails if there are any live or
// noncurrent objects in the bucket, but the request succeeds if the
// bucket only contains soft-deleted objects or incomplete uploads, such
// as ongoing XML API multipart uploads. Does not permanently delete
// soft-deleted objects.
//
// When this API is used to delete a bucket containing an object that has a
// soft delete policy
// enabled, the object becomes soft deleted, and the
// `softDeleteTime` and `hardDeleteTime` properties are set on the
// object.
//
// Objects and multipart uploads that were in the bucket at the time of
// deletion are also retained for the specified retention duration. When
// a soft-deleted bucket reaches the end of its retention duration, it
// is permanently deleted. The `hardDeleteTime` of the bucket always
// equals
// or exceeds the expiration time of the last soft-deleted object in the
// bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.delete` IAM permission on the bucket.
DeleteBucket(ctx context.Context, in *DeleteBucketRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns metadata for the specified bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.get`
// IAM permission on
// the bucket. Additionally, to return specific bucket metadata, the
// authenticated user must have the following permissions:
//
// - To return the IAM policies: `storage.buckets.getIamPolicy`
// - To return the bucket IP filtering rules: `storage.buckets.getIpFilter`
GetBucket(ctx context.Context, in *GetBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// Creates a new bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.create` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated user
// must have the following permissions:
//
// - To enable object retention using the `enableObjectRetention` query
// parameter: `storage.buckets.enableObjectRetention`
// - To set the bucket IP filtering rules: `storage.buckets.setIpFilter`
CreateBucket(ctx context.Context, in *CreateBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// Retrieves a list of buckets for a given project, ordered
// lexicographically by name.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.list` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated
// user must have the following permissions:
//
// - To list the IAM policies: `storage.buckets.getIamPolicy`
// - To list the bucket IP filtering rules: `storage.buckets.getIpFilter`
ListBuckets(ctx context.Context, in *ListBucketsRequest, opts ...grpc.CallOption) (*ListBucketsResponse, error)
// Permanently locks the retention
// policy that is
// currently applied to the specified bucket.
//
// Caution: Locking a bucket is an
// irreversible action. Once you lock a bucket:
//
// - You cannot remove the retention policy from the bucket.
// - You cannot decrease the retention period for the policy.
//
// Once locked, you must delete the entire bucket in order to remove the
// bucket's retention policy. However, before you can delete the bucket, you
// must delete all the objects in the bucket, which is only
// possible if all the objects have reached the retention period set by the
// retention policy.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.update` IAM permission on the bucket.
LockBucketRetentionPolicy(ctx context.Context, in *LockBucketRetentionPolicyRequest, opts ...grpc.CallOption) (*Bucket, error)
// Gets the IAM policy for a specified bucket or managed folder.
// The `resource` field in the request should be
// `projects/_/buckets/{bucket}` for a bucket, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.getIamPolicy` on the bucket or
// `storage.managedFolders.getIamPolicy` IAM permission on the
// managed folder.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Updates an IAM policy for the specified bucket or managed folder.
// The `resource` field in the request should be
// `projects/_/buckets/{bucket}` for a bucket, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Tests a set of permissions on the given bucket, object, or managed folder
// to see which, if any, are held by the caller. The `resource` field in the
// request should be `projects/_/buckets/{bucket}` for a bucket,
// `projects/_/buckets/{bucket}/objects/{object}` for an object, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
// Updates a bucket. Changes to the bucket are readable immediately after
// writing, but configuration changes might take time to propagate. This
// method supports `patch` semantics.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.update` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated user
// must have the following permissions:
//
// - To set bucket IP filtering rules: `storage.buckets.setIpFilter`
// - To update public access prevention policies or access control lists
// (ACLs): `storage.buckets.setIamPolicy`
UpdateBucket(ctx context.Context, in *UpdateBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// Concatenates a list of existing objects into a new object in the same
// bucket. The existing source objects are unaffected by this operation.
//
// **IAM Permissions**:
//
// Requires the `storage.objects.create` and `storage.objects.get` IAM
// permissions to use this method. If the new composite object
// overwrites an existing object, the authenticated user must also have
// the `storage.objects.delete` permission. If the request body includes
// the retention property, the authenticated user must also have the
// `storage.objects.setRetention` IAM permission.
ComposeObject(ctx context.Context, in *ComposeObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Deletes an object and its metadata. Deletions are permanent if versioning
// is not enabled for the bucket, or if the generation parameter is used, or
// if soft delete is not
// enabled for the bucket.
// When this API is used to delete an object from a bucket that has soft
// delete policy enabled, the object becomes soft deleted, and the
// `softDeleteTime` and `hardDeleteTime` properties are set on the object.
// This API cannot be used to permanently delete soft-deleted objects.
// Soft-deleted objects are permanently deleted according to their
// `hardDeleteTime`.
//
// You can use the [`RestoreObject`][google.storage.v2.Storage.RestoreObject]
// API to restore soft-deleted objects until the soft delete retention period
// has passed.
//
// **IAM Permissions**:
//
// Requires `storage.objects.delete` IAM permission on the bucket.
DeleteObject(ctx context.Context, in *DeleteObjectRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Restores a
// soft-deleted object.
// When a soft-deleted object is restored, a new copy of that object is
// created in the same bucket and inherits the same metadata as the
// soft-deleted object. The inherited metadata is the metadata that existed
// when the original object became soft deleted, with the following
// exceptions:
//
// - The `createTime` of the new object is set to the time at which the
// soft-deleted object was restored.
// - The `softDeleteTime` and `hardDeleteTime` values are cleared.
// - A new generation is assigned and the metageneration is reset to 1.
// - If the soft-deleted object was in a bucket that had Autoclass enabled,
// the new object is
// restored to Standard storage.
// - The restored object inherits the bucket's default object ACL, unless
// `copySourceAcl` is `true`.
//
// If a live object using the same name already exists in the bucket and
// becomes overwritten, the live object becomes a noncurrent object if Object
// Versioning is enabled on the bucket. If Object Versioning is not enabled,
// the live object becomes soft deleted.
//
// **IAM Permissions**:
//
// Requires the following IAM permissions to use this method:
//
// - `storage.objects.restore`
// - `storage.objects.create`
// - `storage.objects.delete` (only required if overwriting an existing
// object)
// - `storage.objects.getIamPolicy` (only required if `projection` is `full`
// and the relevant bucket
// has uniform bucket-level access disabled)
// - `storage.objects.setIamPolicy` (only required if `copySourceAcl` is
// `true` and the relevant
// bucket has uniform bucket-level access disabled)
RestoreObject(ctx context.Context, in *RestoreObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Cancels an in-progress resumable upload.
//
// Any attempts to write to the resumable upload after cancelling the upload
// fail.
//
// The behavior for any in-progress write operations is not guaranteed;
// they could either complete before the cancellation or fail if the
// cancellation completes first.
CancelResumableWrite(ctx context.Context, in *CancelResumableWriteRequest, opts ...grpc.CallOption) (*CancelResumableWriteResponse, error)
// Retrieves object metadata.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
// To return object ACLs, the authenticated user must also have
// the `storage.objects.getIamPolicy` permission.
GetObject(ctx context.Context, in *GetObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Retrieves object data.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
ReadObject(ctx context.Context, in *ReadObjectRequest, opts ...grpc.CallOption) (Storage_ReadObjectClient, error)
// Reads an object's data.
//
// This bi-directional API reads data from an object, allowing you to
// request multiple data ranges within a single stream, even across
// several messages. If an error occurs with any request, the stream
// closes with a relevant error code. Since you can have multiple
// outstanding requests, the error response includes a
// `BidiReadObjectRangesError` field detailing the specific error for
// each pending `read_id`.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
BidiReadObject(ctx context.Context, opts ...grpc.CallOption) (Storage_BidiReadObjectClient, error)
// Updates an object's metadata.
// Equivalent to JSON API's `storage.objects.patch` method.
//
// **IAM Permissions**:
//
// Requires `storage.objects.update` IAM permission on the bucket.
UpdateObject(ctx context.Context, in *UpdateObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Stores a new object and metadata.
//
// An object can be written either in a single message stream or in a
// resumable sequence of message streams. To write using a single stream,
// the client should include in the first message of the stream an
// `WriteObjectSpec` describing the destination bucket, object, and any
// preconditions. Additionally, the final message must set 'finish_write' to
// true, or else it is an error.
//
// For a resumable write, the client should instead call
// `StartResumableWrite()`, populating a `WriteObjectSpec` into that request.
// They should then attach the returned `upload_id` to the first message of
// each following call to `WriteObject`. If the stream is closed before
// finishing the upload (either explicitly by the client or due to a network
// error or an error response from the server), the client should do as
// follows:
//
// - Check the result Status of the stream, to determine if writing can be
// resumed on this stream or must be restarted from scratch (by calling
// `StartResumableWrite()`). The resumable errors are `DEADLINE_EXCEEDED`,
// `INTERNAL`, and `UNAVAILABLE`. For each case, the client should use
// binary exponential backoff before retrying. Additionally, writes can
// be resumed after `RESOURCE_EXHAUSTED` errors, but only after taking
// appropriate measures, which might include reducing aggregate send rate
// across clients and/or requesting a quota increase for your project.
// - If the call to `WriteObject` returns `ABORTED`, that indicates
// concurrent attempts to update the resumable write, caused either by
// multiple racing clients or by a single client where the previous
// request was timed out on the client side but nonetheless reached the
// server. In this case the client should take steps to prevent further
// concurrent writes. For example, increase the timeouts and stop using
// more than one process to perform the upload. Follow the steps below for
// resuming the upload.
// - For resumable errors, the client should call `QueryWriteStatus()` and
// then continue writing from the returned `persisted_size`. This might be
// less than the amount of data the client previously sent. Note also that
// it is acceptable to send data starting at an offset earlier than the
// returned `persisted_size`; in this case, the service skips data at
// offsets that were already persisted (without checking that it matches
// the previously written data), and write only the data starting from the
// persisted offset. Even though the data isn't written, it might still
// incur a performance cost over resuming at the correct write offset.
// This behavior can make client-side handling simpler in some cases.
// - Clients must only send data that is a multiple of 256 KiB per message,
// unless the object is being finished with `finish_write` set to `true`.
//
// The service does not view the object as complete until the client has
// sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
// requests on a stream after sending a request with `finish_write` set to
// `true` causes an error. The client must check the response it
// receives to determine how much data the service is able to commit and
// whether the service views the object as complete.
//
// Attempting to resume an already finalized object results in an `OK`
// status, with a `WriteObjectResponse` containing the finalized object's
// metadata.
//
// Alternatively, you can use the `BidiWriteObject` operation to write an
// object with controls over flushing and the ability to fetch the ability to
// determine the current persisted size.
//
// **IAM Permissions**:
//
// Requires `storage.objects.create`
// IAM permission on
// the bucket.
WriteObject(ctx context.Context, opts ...grpc.CallOption) (Storage_WriteObjectClient, error)
// Stores a new object and metadata.
//
// This is similar to the `WriteObject` call with the added support for
// manual flushing of persisted state, and the ability to determine current
// persisted size without closing the stream.
//
// The client might specify one or both of the `state_lookup` and `flush`
// fields in each `BidiWriteObjectRequest`. If `flush` is specified, the data
// written so far is persisted to storage. If `state_lookup` is specified, the
// service responds with a `BidiWriteObjectResponse` that contains the
// persisted size. If both `flush` and `state_lookup` are specified, the flush
// always occurs before a `state_lookup`, so that both might be set in the
// same request and the returned state is the state of the object
// post-flush. When the stream is closed, a `BidiWriteObjectResponse`
// is always sent to the client, regardless of the value of `state_lookup`.
BidiWriteObject(ctx context.Context, opts ...grpc.CallOption) (Storage_BidiWriteObjectClient, error)
// Retrieves a list of objects matching the criteria.
//
// **IAM Permissions**:
//
// The authenticated user requires `storage.objects.list`
// IAM permission to use this method. To return object ACLs, the
// authenticated user must also
// have the `storage.objects.getIamPolicy` permission.
ListObjects(ctx context.Context, in *ListObjectsRequest, opts ...grpc.CallOption) (*ListObjectsResponse, error)
// Rewrites a source object to a destination object. Optionally overrides
// metadata.
RewriteObject(ctx context.Context, in *RewriteObjectRequest, opts ...grpc.CallOption) (*RewriteResponse, error)
// Starts a resumable write operation. This
// method is part of the Resumable
// upload feature.
// This allows you to upload large objects in multiple chunks, which is more
// resilient to network interruptions than a single upload. The validity
// duration of the write operation, and the consequences of it becoming
// invalid, are service-dependent.
//
// **IAM Permissions**:
//
// Requires `storage.objects.create` IAM permission on the bucket.
StartResumableWrite(ctx context.Context, in *StartResumableWriteRequest, opts ...grpc.CallOption) (*StartResumableWriteResponse, error)
// Determines the `persisted_size` of an object that is being written. This
// method is part of the resumable
// upload feature.
// The returned value is the size of the object that has been persisted so
// far. The value can be used as the `write_offset` for the next `Write()`
// call.
//
// If the object does not exist, meaning if it was deleted, or the
// first `Write()` has not yet reached the service, this method returns the
// error `NOT_FOUND`.
//
// This method is useful for clients that buffer data and need to know which
// data can be safely evicted. The client can call `QueryWriteStatus()` at any
// time to determine how much data has been logged for this object.
// For any sequence of `QueryWriteStatus()` calls for a given
// object name, the sequence of returned `persisted_size` values are
// non-decreasing.
QueryWriteStatus(ctx context.Context, in *QueryWriteStatusRequest, opts ...grpc.CallOption) (*QueryWriteStatusResponse, error)
// Moves the source object to the destination object in the same bucket.
// This operation moves a source object to a destination object in the
// same bucket by renaming the object. The move itself is an atomic
// transaction, ensuring all steps either complete successfully or no
// changes are made.
//
// **IAM Permissions**:
//
// Requires the following IAM permissions to use this method:
//
// - `storage.objects.move`
// - `storage.objects.create`
// - `storage.objects.delete` (only required if overwriting an existing
// object)
MoveObject(ctx context.Context, in *MoveObjectRequest, opts ...grpc.CallOption) (*Object, error)
}
StorageClient is the client API for Storage service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewStorageClient ¶
func NewStorageClient(cc grpc.ClientConnInterface) StorageClient
type StorageServer ¶
type StorageServer interface {
// Permanently deletes an empty bucket.
// The request fails if there are any live or
// noncurrent objects in the bucket, but the request succeeds if the
// bucket only contains soft-deleted objects or incomplete uploads, such
// as ongoing XML API multipart uploads. Does not permanently delete
// soft-deleted objects.
//
// When this API is used to delete a bucket containing an object that has a
// soft delete policy
// enabled, the object becomes soft deleted, and the
// `softDeleteTime` and `hardDeleteTime` properties are set on the
// object.
//
// Objects and multipart uploads that were in the bucket at the time of
// deletion are also retained for the specified retention duration. When
// a soft-deleted bucket reaches the end of its retention duration, it
// is permanently deleted. The `hardDeleteTime` of the bucket always
// equals
// or exceeds the expiration time of the last soft-deleted object in the
// bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.delete` IAM permission on the bucket.
DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
// Returns metadata for the specified bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.get`
// IAM permission on
// the bucket. Additionally, to return specific bucket metadata, the
// authenticated user must have the following permissions:
//
// - To return the IAM policies: `storage.buckets.getIamPolicy`
// - To return the bucket IP filtering rules: `storage.buckets.getIpFilter`
GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
// Creates a new bucket.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.create` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated user
// must have the following permissions:
//
// - To enable object retention using the `enableObjectRetention` query
// parameter: `storage.buckets.enableObjectRetention`
// - To set the bucket IP filtering rules: `storage.buckets.setIpFilter`
CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)
// Retrieves a list of buckets for a given project, ordered
// lexicographically by name.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.list` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated
// user must have the following permissions:
//
// - To list the IAM policies: `storage.buckets.getIamPolicy`
// - To list the bucket IP filtering rules: `storage.buckets.getIpFilter`
ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
// Permanently locks the retention
// policy that is
// currently applied to the specified bucket.
//
// Caution: Locking a bucket is an
// irreversible action. Once you lock a bucket:
//
// - You cannot remove the retention policy from the bucket.
// - You cannot decrease the retention period for the policy.
//
// Once locked, you must delete the entire bucket in order to remove the
// bucket's retention policy. However, before you can delete the bucket, you
// must delete all the objects in the bucket, which is only
// possible if all the objects have reached the retention period set by the
// retention policy.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.update` IAM permission on the bucket.
LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)
// Gets the IAM policy for a specified bucket or managed folder.
// The `resource` field in the request should be
// `projects/_/buckets/{bucket}` for a bucket, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.getIamPolicy` on the bucket or
// `storage.managedFolders.getIamPolicy` IAM permission on the
// managed folder.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Updates an IAM policy for the specified bucket or managed folder.
// The `resource` field in the request should be
// `projects/_/buckets/{bucket}` for a bucket, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Tests a set of permissions on the given bucket, object, or managed folder
// to see which, if any, are held by the caller. The `resource` field in the
// request should be `projects/_/buckets/{bucket}` for a bucket,
// `projects/_/buckets/{bucket}/objects/{object}` for an object, or
// `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
// for a managed folder.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
// Updates a bucket. Changes to the bucket are readable immediately after
// writing, but configuration changes might take time to propagate. This
// method supports `patch` semantics.
//
// **IAM Permissions**:
//
// Requires `storage.buckets.update` IAM permission on the bucket.
// Additionally, to enable specific bucket features, the authenticated user
// must have the following permissions:
//
// - To set bucket IP filtering rules: `storage.buckets.setIpFilter`
// - To update public access prevention policies or access control lists
// (ACLs): `storage.buckets.setIamPolicy`
UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
// Concatenates a list of existing objects into a new object in the same
// bucket. The existing source objects are unaffected by this operation.
//
// **IAM Permissions**:
//
// Requires the `storage.objects.create` and `storage.objects.get` IAM
// permissions to use this method. If the new composite object
// overwrites an existing object, the authenticated user must also have
// the `storage.objects.delete` permission. If the request body includes
// the retention property, the authenticated user must also have the
// `storage.objects.setRetention` IAM permission.
ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
// Deletes an object and its metadata. Deletions are permanent if versioning
// is not enabled for the bucket, or if the generation parameter is used, or
// if soft delete is not
// enabled for the bucket.
// When this API is used to delete an object from a bucket that has soft
// delete policy enabled, the object becomes soft deleted, and the
// `softDeleteTime` and `hardDeleteTime` properties are set on the object.
// This API cannot be used to permanently delete soft-deleted objects.
// Soft-deleted objects are permanently deleted according to their
// `hardDeleteTime`.
//
// You can use the [`RestoreObject`][google.storage.v2.Storage.RestoreObject]
// API to restore soft-deleted objects until the soft delete retention period
// has passed.
//
// **IAM Permissions**:
//
// Requires `storage.objects.delete` IAM permission on the bucket.
DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)
// Restores a
// soft-deleted object.
// When a soft-deleted object is restored, a new copy of that object is
// created in the same bucket and inherits the same metadata as the
// soft-deleted object. The inherited metadata is the metadata that existed
// when the original object became soft deleted, with the following
// exceptions:
//
// - The `createTime` of the new object is set to the time at which the
// soft-deleted object was restored.
// - The `softDeleteTime` and `hardDeleteTime` values are cleared.
// - A new generation is assigned and the metageneration is reset to 1.
// - If the soft-deleted object was in a bucket that had Autoclass enabled,
// the new object is
// restored to Standard storage.
// - The restored object inherits the bucket's default object ACL, unless
// `copySourceAcl` is `true`.
//
// If a live object using the same name already exists in the bucket and
// becomes overwritten, the live object becomes a noncurrent object if Object
// Versioning is enabled on the bucket. If Object Versioning is not enabled,
// the live object becomes soft deleted.
//
// **IAM Permissions**:
//
// Requires the following IAM permissions to use this method:
//
// - `storage.objects.restore`
// - `storage.objects.create`
// - `storage.objects.delete` (only required if overwriting an existing
// object)
// - `storage.objects.getIamPolicy` (only required if `projection` is `full`
// and the relevant bucket
// has uniform bucket-level access disabled)
// - `storage.objects.setIamPolicy` (only required if `copySourceAcl` is
// `true` and the relevant
// bucket has uniform bucket-level access disabled)
RestoreObject(context.Context, *RestoreObjectRequest) (*Object, error)
// Cancels an in-progress resumable upload.
//
// Any attempts to write to the resumable upload after cancelling the upload
// fail.
//
// The behavior for any in-progress write operations is not guaranteed;
// they could either complete before the cancellation or fail if the
// cancellation completes first.
CancelResumableWrite(context.Context, *CancelResumableWriteRequest) (*CancelResumableWriteResponse, error)
// Retrieves object metadata.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
// To return object ACLs, the authenticated user must also have
// the `storage.objects.getIamPolicy` permission.
GetObject(context.Context, *GetObjectRequest) (*Object, error)
// Retrieves object data.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error
// Reads an object's data.
//
// This bi-directional API reads data from an object, allowing you to
// request multiple data ranges within a single stream, even across
// several messages. If an error occurs with any request, the stream
// closes with a relevant error code. Since you can have multiple
// outstanding requests, the error response includes a
// `BidiReadObjectRangesError` field detailing the specific error for
// each pending `read_id`.
//
// **IAM Permissions**:
//
// Requires `storage.objects.get` IAM permission on the bucket.
BidiReadObject(Storage_BidiReadObjectServer) error
// Updates an object's metadata.
// Equivalent to JSON API's `storage.objects.patch` method.
//
// **IAM Permissions**:
//
// Requires `storage.objects.update` IAM permission on the bucket.
UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
// Stores a new object and metadata.
//
// An object can be written either in a single message stream or in a
// resumable sequence of message streams. To write using a single stream,
// the client should include in the first message of the stream an
// `WriteObjectSpec` describing the destination bucket, object, and any
// preconditions. Additionally, the final message must set 'finish_write' to
// true, or else it is an error.
//
// For a resumable write, the client should instead call
// `StartResumableWrite()`, populating a `WriteObjectSpec` into that request.
// They should then attach the returned `upload_id` to the first message of
// each following call to `WriteObject`. If the stream is closed before
// finishing the upload (either explicitly by the client or due to a network
// error or an error response from the server), the client should do as
// follows:
//
// - Check the result Status of the stream, to determine if writing can be
// resumed on this stream or must be restarted from scratch (by calling
// `StartResumableWrite()`). The resumable errors are `DEADLINE_EXCEEDED`,
// `INTERNAL`, and `UNAVAILABLE`. For each case, the client should use
// binary exponential backoff before retrying. Additionally, writes can
// be resumed after `RESOURCE_EXHAUSTED` errors, but only after taking
// appropriate measures, which might include reducing aggregate send rate
// across clients and/or requesting a quota increase for your project.
// - If the call to `WriteObject` returns `ABORTED`, that indicates
// concurrent attempts to update the resumable write, caused either by
// multiple racing clients or by a single client where the previous
// request was timed out on the client side but nonetheless reached the
// server. In this case the client should take steps to prevent further
// concurrent writes. For example, increase the timeouts and stop using
// more than one process to perform the upload. Follow the steps below for
// resuming the upload.
// - For resumable errors, the client should call `QueryWriteStatus()` and
// then continue writing from the returned `persisted_size`. This might be
// less than the amount of data the client previously sent. Note also that
// it is acceptable to send data starting at an offset earlier than the
// returned `persisted_size`; in this case, the service skips data at
// offsets that were already persisted (without checking that it matches
// the previously written data), and write only the data starting from the
// persisted offset. Even though the data isn't written, it might still
// incur a performance cost over resuming at the correct write offset.
// This behavior can make client-side handling simpler in some cases.
// - Clients must only send data that is a multiple of 256 KiB per message,
// unless the object is being finished with `finish_write` set to `true`.
//
// The service does not view the object as complete until the client has
// sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
// requests on a stream after sending a request with `finish_write` set to
// `true` causes an error. The client must check the response it
// receives to determine how much data the service is able to commit and
// whether the service views the object as complete.
//
// Attempting to resume an already finalized object results in an `OK`
// status, with a `WriteObjectResponse` containing the finalized object's
// metadata.
//
// Alternatively, you can use the `BidiWriteObject` operation to write an
// object with controls over flushing and the ability to fetch the ability to
// determine the current persisted size.
//
// **IAM Permissions**:
//
// Requires `storage.objects.create`
// IAM permission on
// the bucket.
WriteObject(Storage_WriteObjectServer) error
// Stores a new object and metadata.
//
// This is similar to the `WriteObject` call with the added support for
// manual flushing of persisted state, and the ability to determine current
// persisted size without closing the stream.
//
// The client might specify one or both of the `state_lookup` and `flush`
// fields in each `BidiWriteObjectRequest`. If `flush` is specified, the data
// written so far is persisted to storage. If `state_lookup` is specified, the
// service responds with a `BidiWriteObjectResponse` that contains the
// persisted size. If both `flush` and `state_lookup` are specified, the flush
// always occurs before a `state_lookup`, so that both might be set in the
// same request and the returned state is the state of the object
// post-flush. When the stream is closed, a `BidiWriteObjectResponse`
// is always sent to the client, regardless of the value of `state_lookup`.
BidiWriteObject(Storage_BidiWriteObjectServer) error
// Retrieves a list of objects matching the criteria.
//
// **IAM Permissions**:
//
// The authenticated user requires `storage.objects.list`
// IAM permission to use this method. To return object ACLs, the
// authenticated user must also
// have the `storage.objects.getIamPolicy` permission.
ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
// Rewrites a source object to a destination object. Optionally overrides
// metadata.
RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
// Starts a resumable write operation. This
// method is part of the Resumable
// upload feature.
// This allows you to upload large objects in multiple chunks, which is more
// resilient to network interruptions than a single upload. The validity
// duration of the write operation, and the consequences of it becoming
// invalid, are service-dependent.
//
// **IAM Permissions**:
//
// Requires `storage.objects.create` IAM permission on the bucket.
StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
// Determines the `persisted_size` of an object that is being written. This
// method is part of the resumable
// upload feature.
// The returned value is the size of the object that has been persisted so
// far. The value can be used as the `write_offset` for the next `Write()`
// call.
//
// If the object does not exist, meaning if it was deleted, or the
// first `Write()` has not yet reached the service, this method returns the
// error `NOT_FOUND`.
//
// This method is useful for clients that buffer data and need to know which
// data can be safely evicted. The client can call `QueryWriteStatus()` at any
// time to determine how much data has been logged for this object.
// For any sequence of `QueryWriteStatus()` calls for a given
// object name, the sequence of returned `persisted_size` values are
// non-decreasing.
QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
// Moves the source object to the destination object in the same bucket.
// This operation moves a source object to a destination object in the
// same bucket by renaming the object. The move itself is an atomic
// transaction, ensuring all steps either complete successfully or no
// changes are made.
//
// **IAM Permissions**:
//
// Requires the following IAM permissions to use this method:
//
// - `storage.objects.move`
// - `storage.objects.create`
// - `storage.objects.delete` (only required if overwriting an existing
// object)
MoveObject(context.Context, *MoveObjectRequest) (*Object, error)
}
StorageServer is the server API for Storage service. All implementations should embed UnimplementedStorageServer for forward compatibility
type Storage_BidiReadObjectClient ¶ added in v1.50.0
type Storage_BidiReadObjectClient interface {
Send(*BidiReadObjectRequest) error
Recv() (*BidiReadObjectResponse, error)
grpc.ClientStream
}
type Storage_BidiReadObjectServer ¶ added in v1.50.0
type Storage_BidiReadObjectServer interface {
Send(*BidiReadObjectResponse) error
Recv() (*BidiReadObjectRequest, error)
grpc.ServerStream
}
type Storage_BidiWriteObjectClient ¶ added in v1.34.0
type Storage_BidiWriteObjectClient interface {
Send(*BidiWriteObjectRequest) error
Recv() (*BidiWriteObjectResponse, error)
grpc.ClientStream
}
type Storage_BidiWriteObjectServer ¶ added in v1.34.0
type Storage_BidiWriteObjectServer interface {
Send(*BidiWriteObjectResponse) error
Recv() (*BidiWriteObjectRequest, error)
grpc.ServerStream
}
type Storage_ReadObjectClient ¶
type Storage_ReadObjectClient interface {
Recv() (*ReadObjectResponse, error)
grpc.ClientStream
}
type Storage_ReadObjectServer ¶
type Storage_ReadObjectServer interface {
Send(*ReadObjectResponse) error
grpc.ServerStream
}
type Storage_WriteObjectClient ¶
type Storage_WriteObjectClient interface {
Send(*WriteObjectRequest) error
CloseAndRecv() (*WriteObjectResponse, error)
grpc.ClientStream
}
type Storage_WriteObjectServer ¶
type Storage_WriteObjectServer interface {
SendAndClose(*WriteObjectResponse) error
Recv() (*WriteObjectRequest, error)
grpc.ServerStream
}
type UnimplementedStorageServer ¶
type UnimplementedStorageServer struct {
}
UnimplementedStorageServer should be embedded to have forward compatible implementations.
func (UnimplementedStorageServer) BidiReadObject ¶ added in v1.50.0
func (UnimplementedStorageServer) BidiReadObject(Storage_BidiReadObjectServer) error
func (UnimplementedStorageServer) BidiWriteObject ¶ added in v1.34.0
func (UnimplementedStorageServer) BidiWriteObject(Storage_BidiWriteObjectServer) error
func (UnimplementedStorageServer) CancelResumableWrite ¶
func (UnimplementedStorageServer) CancelResumableWrite(context.Context, *CancelResumableWriteRequest) (*CancelResumableWriteResponse, error)
func (UnimplementedStorageServer) ComposeObject ¶
func (UnimplementedStorageServer) ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
func (UnimplementedStorageServer) CreateBucket ¶
func (UnimplementedStorageServer) CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)
func (UnimplementedStorageServer) DeleteBucket ¶
func (UnimplementedStorageServer) DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
func (UnimplementedStorageServer) DeleteObject ¶
func (UnimplementedStorageServer) DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)
func (UnimplementedStorageServer) GetBucket ¶
func (UnimplementedStorageServer) GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
func (UnimplementedStorageServer) GetIamPolicy ¶
func (UnimplementedStorageServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (UnimplementedStorageServer) GetObject ¶
func (UnimplementedStorageServer) GetObject(context.Context, *GetObjectRequest) (*Object, error)
func (UnimplementedStorageServer) ListBuckets ¶
func (UnimplementedStorageServer) ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
func (UnimplementedStorageServer) ListObjects ¶
func (UnimplementedStorageServer) ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
func (UnimplementedStorageServer) LockBucketRetentionPolicy ¶
func (UnimplementedStorageServer) LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)
func (UnimplementedStorageServer) MoveObject ¶ added in v1.49.0
func (UnimplementedStorageServer) MoveObject(context.Context, *MoveObjectRequest) (*Object, error)
func (UnimplementedStorageServer) QueryWriteStatus ¶
func (UnimplementedStorageServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
func (UnimplementedStorageServer) ReadObject ¶
func (UnimplementedStorageServer) ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error
func (UnimplementedStorageServer) RestoreObject ¶ added in v1.34.0
func (UnimplementedStorageServer) RestoreObject(context.Context, *RestoreObjectRequest) (*Object, error)
func (UnimplementedStorageServer) RewriteObject ¶
func (UnimplementedStorageServer) RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
func (UnimplementedStorageServer) SetIamPolicy ¶
func (UnimplementedStorageServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (UnimplementedStorageServer) StartResumableWrite ¶
func (UnimplementedStorageServer) StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
func (UnimplementedStorageServer) TestIamPermissions ¶
func (UnimplementedStorageServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (UnimplementedStorageServer) UpdateBucket ¶
func (UnimplementedStorageServer) UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
func (UnimplementedStorageServer) UpdateObject ¶
func (UnimplementedStorageServer) UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
func (UnimplementedStorageServer) WriteObject ¶
func (UnimplementedStorageServer) WriteObject(Storage_WriteObjectServer) error
type UnsafeStorageServer ¶ added in v1.57.1
type UnsafeStorageServer interface {
// contains filtered or unexported methods
}
UnsafeStorageServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StorageServer will result in compilation errors.
type UpdateBucketRequest ¶
type UpdateBucketRequest struct {
// Required. The bucket to update.
// The bucket's `name` field is used to identify the bucket.
Bucket *Bucket `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// If set, the request modifies the bucket if its metageneration matches this
// value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// If set, the request modifies the bucket if its metageneration doesn't
// match this value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. Apply a predefined set of access controls to this bucket.
// Valid values are `authenticatedRead`, `private`, `projectPrivate`,
// `publicRead`, or `publicReadWrite`.
PredefinedAcl string `protobuf:"bytes,8,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
// Optional. Apply a predefined set of default object access controls to this
// bucket. Valid values are `authenticatedRead`, `bucketOwnerFullControl`,
// `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`.
PredefinedDefaultObjectAcl string `` /* 143-byte string literal not displayed */
// Required. List of fields to be updated.
//
// To specify ALL fields, equivalent to the JSON API's "update" function,
// specify a single field with the value `*`. Note: not recommended. If a new
// field is introduced at a later time, an older client updating with the `*`
// might accidentally reset the new field's value.
//
// Not specifying any fields is an error.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
Request for [UpdateBucket][google.storage.v2.Storage.UpdateBucket] method.
func (*UpdateBucketRequest) Descriptor
deprecated
func (*UpdateBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBucketRequest.ProtoReflect.Descriptor instead.
func (*UpdateBucketRequest) GetBucket ¶
func (x *UpdateBucketRequest) GetBucket() *Bucket
func (*UpdateBucketRequest) GetIfMetagenerationMatch ¶
func (x *UpdateBucketRequest) GetIfMetagenerationMatch() int64
func (*UpdateBucketRequest) GetIfMetagenerationNotMatch ¶
func (x *UpdateBucketRequest) GetIfMetagenerationNotMatch() int64
func (*UpdateBucketRequest) GetPredefinedAcl ¶
func (x *UpdateBucketRequest) GetPredefinedAcl() string
func (*UpdateBucketRequest) GetPredefinedDefaultObjectAcl ¶
func (x *UpdateBucketRequest) GetPredefinedDefaultObjectAcl() string
func (*UpdateBucketRequest) GetUpdateMask ¶
func (x *UpdateBucketRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateBucketRequest) ProtoMessage ¶
func (*UpdateBucketRequest) ProtoMessage()
func (*UpdateBucketRequest) ProtoReflect ¶
func (x *UpdateBucketRequest) ProtoReflect() protoreflect.Message
func (*UpdateBucketRequest) Reset ¶
func (x *UpdateBucketRequest) Reset()
func (*UpdateBucketRequest) String ¶
func (x *UpdateBucketRequest) String() string
type UpdateObjectRequest ¶
type UpdateObjectRequest struct {
// Required. The object to update.
// The object's bucket and name fields are used to identify the object to
// update. If present, the object's generation field selects a specific
// revision of this object whose metadata should be updated. Otherwise,
// assumes the live version of the object.
Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
// Makes the operation conditional on whether the object's current generation
// matches the given value. Setting to 0 makes the operation succeed only if
// there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,2,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// Optional. Apply a predefined set of access controls to this object.
// Valid values are "authenticatedRead", "bucketOwnerFullControl",
// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
PredefinedAcl string `protobuf:"bytes,10,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
// Required. List of fields to be updated.
//
// To specify ALL fields, equivalent to the JSON API's "update" function,
// specify a single field with the value `*`. Note: not recommended. If a new
// field is introduced at a later time, an older client updating with the `*`
// might accidentally reset the new field's value.
//
// Not specifying any fields is an error.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Optional. A set of parameters common to Storage API requests concerning an
// object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// Optional. Overrides the unlocked retention config on the object.
OverrideUnlockedRetention bool `` /* 140-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [UpdateObject][google.storage.v2.Storage.UpdateObject].
func (*UpdateObjectRequest) Descriptor
deprecated
func (*UpdateObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateObjectRequest.ProtoReflect.Descriptor instead.
func (*UpdateObjectRequest) GetCommonObjectRequestParams ¶
func (x *UpdateObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*UpdateObjectRequest) GetIfGenerationMatch ¶
func (x *UpdateObjectRequest) GetIfGenerationMatch() int64
func (*UpdateObjectRequest) GetIfGenerationNotMatch ¶
func (x *UpdateObjectRequest) GetIfGenerationNotMatch() int64
func (*UpdateObjectRequest) GetIfMetagenerationMatch ¶
func (x *UpdateObjectRequest) GetIfMetagenerationMatch() int64
func (*UpdateObjectRequest) GetIfMetagenerationNotMatch ¶
func (x *UpdateObjectRequest) GetIfMetagenerationNotMatch() int64
func (*UpdateObjectRequest) GetObject ¶
func (x *UpdateObjectRequest) GetObject() *Object
func (*UpdateObjectRequest) GetOverrideUnlockedRetention ¶ added in v1.56.0
func (x *UpdateObjectRequest) GetOverrideUnlockedRetention() bool
func (*UpdateObjectRequest) GetPredefinedAcl ¶
func (x *UpdateObjectRequest) GetPredefinedAcl() string
func (*UpdateObjectRequest) GetUpdateMask ¶
func (x *UpdateObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateObjectRequest) ProtoMessage ¶
func (*UpdateObjectRequest) ProtoMessage()
func (*UpdateObjectRequest) ProtoReflect ¶
func (x *UpdateObjectRequest) ProtoReflect() protoreflect.Message
func (*UpdateObjectRequest) Reset ¶
func (x *UpdateObjectRequest) Reset()
func (*UpdateObjectRequest) String ¶
func (x *UpdateObjectRequest) String() string
type WriteObjectRequest ¶
type WriteObjectRequest struct {
// The first message of each stream should set one of the following.
//
// Types that are assignable to FirstMessage:
//
// *WriteObjectRequest_UploadId
// *WriteObjectRequest_WriteObjectSpec
FirstMessage isWriteObjectRequest_FirstMessage `protobuf_oneof:"first_message"`
// Required. The offset from the beginning of the object at which the data
// should be written.
//
// In the first `WriteObjectRequest` of a `WriteObject()` action, it
// indicates the initial offset for the `Write()` call. The value **must** be
// equal to the `persisted_size` that a call to `QueryWriteStatus()` would
// return (0 if this is the first write to the object).
//
// On subsequent calls, this value **must** be no larger than the sum of the
// first `write_offset` and the sizes of all `data` chunks sent previously on
// this stream.
//
// An incorrect value causes an error.
WriteOffset int64 `protobuf:"varint,3,opt,name=write_offset,json=writeOffset,proto3" json:"write_offset,omitempty"`
// A portion of the data for the object.
//
// Types that are assignable to Data:
//
// *WriteObjectRequest_ChecksummedData
Data isWriteObjectRequest_Data `protobuf_oneof:"data"`
// Optional. Checksums for the complete object. If the checksums computed by
// the service don't match the specified checksums the call fails. This field
// might only be provided in the first or last request (either with
// `first_message`, or `finish_write` set).
ObjectChecksums *ObjectChecksums `protobuf:"bytes,6,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
// Optional. If `true`, this indicates that the write is complete. Sending any
// `WriteObjectRequest`s subsequent to one in which `finish_write` is `true`
// causes an error.
// For a non-resumable write (where the `upload_id` was not set in the first
// message), it is an error not to set this field in the final message of the
// stream.
FinishWrite bool `protobuf:"varint,7,opt,name=finish_write,json=finishWrite,proto3" json:"finish_write,omitempty"`
// Optional. A set of parameters common to Cloud Storage API requests
// concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
// contains filtered or unexported fields
}
Request message for [WriteObject][google.storage.v2.Storage.WriteObject].
func (*WriteObjectRequest) Descriptor
deprecated
func (*WriteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectRequest.ProtoReflect.Descriptor instead.
func (*WriteObjectRequest) GetChecksummedData ¶
func (x *WriteObjectRequest) GetChecksummedData() *ChecksummedData
func (*WriteObjectRequest) GetCommonObjectRequestParams ¶
func (x *WriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (*WriteObjectRequest) GetData ¶
func (m *WriteObjectRequest) GetData() isWriteObjectRequest_Data
func (*WriteObjectRequest) GetFinishWrite ¶
func (x *WriteObjectRequest) GetFinishWrite() bool
func (*WriteObjectRequest) GetFirstMessage ¶
func (m *WriteObjectRequest) GetFirstMessage() isWriteObjectRequest_FirstMessage
func (*WriteObjectRequest) GetObjectChecksums ¶
func (x *WriteObjectRequest) GetObjectChecksums() *ObjectChecksums
func (*WriteObjectRequest) GetUploadId ¶
func (x *WriteObjectRequest) GetUploadId() string
func (*WriteObjectRequest) GetWriteObjectSpec ¶
func (x *WriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec
func (*WriteObjectRequest) GetWriteOffset ¶
func (x *WriteObjectRequest) GetWriteOffset() int64
func (*WriteObjectRequest) ProtoMessage ¶
func (*WriteObjectRequest) ProtoMessage()
func (*WriteObjectRequest) ProtoReflect ¶
func (x *WriteObjectRequest) ProtoReflect() protoreflect.Message
func (*WriteObjectRequest) Reset ¶
func (x *WriteObjectRequest) Reset()
func (*WriteObjectRequest) String ¶
func (x *WriteObjectRequest) String() string
type WriteObjectRequest_ChecksummedData ¶
type WriteObjectRequest_ChecksummedData struct {
// The data to insert. If a crc32c checksum is provided that doesn't match
// the checksum computed by the service, the request fails.
ChecksummedData *ChecksummedData `protobuf:"bytes,4,opt,name=checksummed_data,json=checksummedData,proto3,oneof"`
}
type WriteObjectRequest_UploadId ¶
type WriteObjectRequest_UploadId struct {
// For resumable uploads. This should be the `upload_id` returned from a
// call to `StartResumableWriteResponse`.
UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3,oneof"`
}
type WriteObjectRequest_WriteObjectSpec ¶
type WriteObjectRequest_WriteObjectSpec struct {
// For non-resumable uploads. Describes the overall upload, including the
// destination bucket and object name, preconditions, etc.
WriteObjectSpec *WriteObjectSpec `protobuf:"bytes,2,opt,name=write_object_spec,json=writeObjectSpec,proto3,oneof"`
}
type WriteObjectResponse ¶
type WriteObjectResponse struct {
// The response sets one of the following.
//
// Types that are assignable to WriteStatus:
//
// *WriteObjectResponse_PersistedSize
// *WriteObjectResponse_Resource
WriteStatus isWriteObjectResponse_WriteStatus `protobuf_oneof:"write_status"`
// contains filtered or unexported fields
}
Response message for [WriteObject][google.storage.v2.Storage.WriteObject].
func (*WriteObjectResponse) Descriptor
deprecated
func (*WriteObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectResponse.ProtoReflect.Descriptor instead.
func (*WriteObjectResponse) GetPersistedSize ¶
func (x *WriteObjectResponse) GetPersistedSize() int64
func (*WriteObjectResponse) GetResource ¶
func (x *WriteObjectResponse) GetResource() *Object
func (*WriteObjectResponse) GetWriteStatus ¶
func (m *WriteObjectResponse) GetWriteStatus() isWriteObjectResponse_WriteStatus
func (*WriteObjectResponse) ProtoMessage ¶
func (*WriteObjectResponse) ProtoMessage()
func (*WriteObjectResponse) ProtoReflect ¶
func (x *WriteObjectResponse) ProtoReflect() protoreflect.Message
func (*WriteObjectResponse) Reset ¶
func (x *WriteObjectResponse) Reset()
func (*WriteObjectResponse) String ¶
func (x *WriteObjectResponse) String() string
type WriteObjectResponse_PersistedSize ¶
type WriteObjectResponse_PersistedSize struct {
// The total number of bytes that have been processed for the given object
// from all `WriteObject` calls. Only set if the upload has not finalized.
PersistedSize int64 `protobuf:"varint,1,opt,name=persisted_size,json=persistedSize,proto3,oneof"`
}
type WriteObjectResponse_Resource ¶
type WriteObjectResponse_Resource struct {
// A resource containing the metadata for the uploaded object. Only set if
// the upload has finalized.
Resource *Object `protobuf:"bytes,2,opt,name=resource,proto3,oneof"`
}
type WriteObjectSpec ¶
type WriteObjectSpec struct {
// Required. Destination object, including its name and its metadata.
Resource *Object `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// Optional. Apply a predefined set of access controls to this object.
// Valid values are `authenticatedRead`, `bucketOwnerFullControl`,
// `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`.
PredefinedAcl string `protobuf:"bytes,7,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
// Makes the operation conditional on whether the object's current
// generation matches the given value. Setting to `0` makes the operation
// succeed only if there are no live versions of the object.
IfGenerationMatch *int64 `protobuf:"varint,3,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's live
// generation does not match the given value. If no live object exists, the
// precondition fails. Setting to `0` makes the operation succeed only if
// there is a live version of the object.
IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
// The expected final object size being uploaded.
// If this value is set, closing the stream after writing fewer or more than
// `object_size` bytes results in an `OUT_OF_RANGE` error.
//
// This situation is considered a client error, and if such an error occurs
// you must start the upload over from scratch, this time sending the correct
// number of bytes.
ObjectSize *int64 `protobuf:"varint,8,opt,name=object_size,json=objectSize,proto3,oneof" json:"object_size,omitempty"`
// If `true`, the object is created in appendable mode.
// This field might only be set when using `BidiWriteObject`.
Appendable *bool `protobuf:"varint,9,opt,name=appendable,proto3,oneof" json:"appendable,omitempty"`
// contains filtered or unexported fields
}
Describes an attempt to insert an object, possibly over multiple requests.
func (*WriteObjectSpec) Descriptor
deprecated
func (*WriteObjectSpec) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectSpec.ProtoReflect.Descriptor instead.
func (*WriteObjectSpec) GetAppendable ¶ added in v1.50.0
func (x *WriteObjectSpec) GetAppendable() bool
func (*WriteObjectSpec) GetIfGenerationMatch ¶
func (x *WriteObjectSpec) GetIfGenerationMatch() int64
func (*WriteObjectSpec) GetIfGenerationNotMatch ¶
func (x *WriteObjectSpec) GetIfGenerationNotMatch() int64
func (*WriteObjectSpec) GetIfMetagenerationMatch ¶
func (x *WriteObjectSpec) GetIfMetagenerationMatch() int64
func (*WriteObjectSpec) GetIfMetagenerationNotMatch ¶
func (x *WriteObjectSpec) GetIfMetagenerationNotMatch() int64
func (*WriteObjectSpec) GetObjectSize ¶
func (x *WriteObjectSpec) GetObjectSize() int64
func (*WriteObjectSpec) GetPredefinedAcl ¶
func (x *WriteObjectSpec) GetPredefinedAcl() string
func (*WriteObjectSpec) GetResource ¶
func (x *WriteObjectSpec) GetResource() *Object
func (*WriteObjectSpec) ProtoMessage ¶
func (*WriteObjectSpec) ProtoMessage()
func (*WriteObjectSpec) ProtoReflect ¶
func (x *WriteObjectSpec) ProtoReflect() protoreflect.Message
func (*WriteObjectSpec) Reset ¶
func (x *WriteObjectSpec) Reset()
func (*WriteObjectSpec) String ¶
func (x *WriteObjectSpec) String() string