Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterStorageBatchOperationsServer(s grpc.ServiceRegistrar, srv StorageBatchOperationsServer)
- type BucketList
- type BucketList_Bucket
- func (*BucketList_Bucket) Descriptor() ([]byte, []int)deprecated
- func (x *BucketList_Bucket) GetBucket() string
- func (x *BucketList_Bucket) GetManifest() *Manifest
- func (m *BucketList_Bucket) GetObjectConfiguration() isBucketList_Bucket_ObjectConfiguration
- func (x *BucketList_Bucket) GetPrefixList() *PrefixList
- func (*BucketList_Bucket) ProtoMessage()
- func (x *BucketList_Bucket) ProtoReflect() protoreflect.Message
- func (x *BucketList_Bucket) Reset()
- func (x *BucketList_Bucket) String() string
- type BucketList_Bucket_Manifest
- type BucketList_Bucket_PrefixList
- type BucketOperation
- func (*BucketOperation) Descriptor() ([]byte, []int)deprecated
- func (x *BucketOperation) GetBucketName() string
- func (x *BucketOperation) GetCompleteTime() *timestamppb.Timestamp
- func (x *BucketOperation) GetCounters() *Counters
- func (x *BucketOperation) GetCreateTime() *timestamppb.Timestamp
- func (x *BucketOperation) GetDeleteObject() *DeleteObject
- func (x *BucketOperation) GetErrorSummaries() []*ErrorSummary
- func (x *BucketOperation) GetManifest() *Manifest
- func (x *BucketOperation) GetName() string
- func (m *BucketOperation) GetObjectConfiguration() isBucketOperation_ObjectConfiguration
- func (x *BucketOperation) GetPrefixList() *PrefixList
- func (x *BucketOperation) GetPutMetadata() *PutMetadata
- func (x *BucketOperation) GetPutObjectHold() *PutObjectHold
- func (x *BucketOperation) GetRewriteObject() *RewriteObject
- func (x *BucketOperation) GetStartTime() *timestamppb.Timestamp
- func (x *BucketOperation) GetState() BucketOperation_State
- func (m *BucketOperation) GetTransformation() isBucketOperation_Transformation
- func (x *BucketOperation) GetUpdateObjectCustomContext() *UpdateObjectCustomContext
- func (*BucketOperation) ProtoMessage()
- func (x *BucketOperation) ProtoReflect() protoreflect.Message
- func (x *BucketOperation) Reset()
- func (x *BucketOperation) String() string
- type BucketOperation_DeleteObject
- type BucketOperation_Manifest
- type BucketOperation_PrefixList
- type BucketOperation_PutMetadata
- type BucketOperation_PutObjectHold
- type BucketOperation_RewriteObject
- type BucketOperation_State
- func (BucketOperation_State) Descriptor() protoreflect.EnumDescriptor
- func (x BucketOperation_State) Enum() *BucketOperation_State
- func (BucketOperation_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x BucketOperation_State) Number() protoreflect.EnumNumber
- func (x BucketOperation_State) String() string
- func (BucketOperation_State) Type() protoreflect.EnumType
- type BucketOperation_UpdateObjectCustomContext
- type CancelJobRequest
- func (*CancelJobRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CancelJobRequest) GetName() string
- func (x *CancelJobRequest) GetRequestId() string
- func (*CancelJobRequest) ProtoMessage()
- func (x *CancelJobRequest) ProtoReflect() protoreflect.Message
- func (x *CancelJobRequest) Reset()
- func (x *CancelJobRequest) String() string
- type CancelJobResponse
- type Counters
- func (*Counters) Descriptor() ([]byte, []int)deprecated
- func (x *Counters) GetFailedObjectCount() int64
- func (x *Counters) GetSucceededObjectCount() int64
- func (x *Counters) GetTotalBytesFound() int64
- func (x *Counters) GetTotalObjectCount() int64
- func (*Counters) ProtoMessage()
- func (x *Counters) ProtoReflect() protoreflect.Message
- func (x *Counters) Reset()
- func (x *Counters) String() string
- type CreateJobRequest
- func (*CreateJobRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateJobRequest) GetJob() *Job
- func (x *CreateJobRequest) GetJobId() string
- func (x *CreateJobRequest) GetParent() string
- func (x *CreateJobRequest) GetRequestId() string
- func (*CreateJobRequest) ProtoMessage()
- func (x *CreateJobRequest) ProtoReflect() protoreflect.Message
- func (x *CreateJobRequest) Reset()
- func (x *CreateJobRequest) String() string
- type CustomContextUpdates
- func (*CustomContextUpdates) Descriptor() ([]byte, []int)deprecated
- func (x *CustomContextUpdates) GetKeysToClear() []string
- func (x *CustomContextUpdates) GetUpdates() map[string]*ObjectCustomContextPayload
- func (*CustomContextUpdates) ProtoMessage()
- func (x *CustomContextUpdates) ProtoReflect() protoreflect.Message
- func (x *CustomContextUpdates) Reset()
- func (x *CustomContextUpdates) String() string
- type DeleteJobRequest
- func (*DeleteJobRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteJobRequest) GetForce() bool
- func (x *DeleteJobRequest) GetName() string
- func (x *DeleteJobRequest) GetRequestId() string
- func (*DeleteJobRequest) ProtoMessage()
- func (x *DeleteJobRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteJobRequest) Reset()
- func (x *DeleteJobRequest) String() string
- type DeleteObject
- type ErrorLogEntry
- func (*ErrorLogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *ErrorLogEntry) GetErrorDetails() []string
- func (x *ErrorLogEntry) GetObjectUri() string
- func (*ErrorLogEntry) ProtoMessage()
- func (x *ErrorLogEntry) ProtoReflect() protoreflect.Message
- func (x *ErrorLogEntry) Reset()
- func (x *ErrorLogEntry) String() string
- type ErrorSummary
- func (*ErrorSummary) Descriptor() ([]byte, []int)deprecated
- func (x *ErrorSummary) GetErrorCode() code.Code
- func (x *ErrorSummary) GetErrorCount() int64
- func (x *ErrorSummary) GetErrorLogEntries() []*ErrorLogEntry
- func (*ErrorSummary) ProtoMessage()
- func (x *ErrorSummary) ProtoReflect() protoreflect.Message
- func (x *ErrorSummary) Reset()
- func (x *ErrorSummary) String() string
- type GetBucketOperationRequest
- func (*GetBucketOperationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetBucketOperationRequest) GetName() string
- func (*GetBucketOperationRequest) ProtoMessage()
- func (x *GetBucketOperationRequest) ProtoReflect() protoreflect.Message
- func (x *GetBucketOperationRequest) Reset()
- func (x *GetBucketOperationRequest) String() string
- type GetJobRequest
- type Job
- func (*Job) Descriptor() ([]byte, []int)deprecated
- func (x *Job) GetBucketList() *BucketList
- func (x *Job) GetCompleteTime() *timestamppb.Timestamp
- func (x *Job) GetCounters() *Counters
- func (x *Job) GetCreateTime() *timestamppb.Timestamp
- func (x *Job) GetDeleteObject() *DeleteObject
- func (x *Job) GetDescription() string
- func (x *Job) GetDryRun() bool
- func (x *Job) GetErrorSummaries() []*ErrorSummary
- func (x *Job) GetIsMultiBucketJob() bool
- func (x *Job) GetLoggingConfig() *LoggingConfig
- func (x *Job) GetName() string
- func (x *Job) GetPutMetadata() *PutMetadata
- func (x *Job) GetPutObjectHold() *PutObjectHold
- func (x *Job) GetRewriteObject() *RewriteObject
- func (x *Job) GetScheduleTime() *timestamppb.Timestamp
- func (m *Job) GetSource() isJob_Source
- func (x *Job) GetState() Job_State
- func (m *Job) GetTransformation() isJob_Transformation
- func (x *Job) GetUpdateObjectCustomContext() *UpdateObjectCustomContext
- func (*Job) ProtoMessage()
- func (x *Job) ProtoReflect() protoreflect.Message
- func (x *Job) Reset()
- func (x *Job) String() string
- type Job_BucketList
- type Job_DeleteObject
- type Job_PutMetadata
- type Job_PutObjectHold
- type Job_RewriteObject
- type Job_State
- type Job_UpdateObjectCustomContext
- type ListBucketOperationsRequest
- func (*ListBucketOperationsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListBucketOperationsRequest) GetFilter() string
- func (x *ListBucketOperationsRequest) GetOrderBy() string
- func (x *ListBucketOperationsRequest) GetPageSize() int32
- func (x *ListBucketOperationsRequest) GetPageToken() string
- func (x *ListBucketOperationsRequest) GetParent() string
- func (*ListBucketOperationsRequest) ProtoMessage()
- func (x *ListBucketOperationsRequest) ProtoReflect() protoreflect.Message
- func (x *ListBucketOperationsRequest) Reset()
- func (x *ListBucketOperationsRequest) String() string
- type ListBucketOperationsResponse
- func (*ListBucketOperationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListBucketOperationsResponse) GetBucketOperations() []*BucketOperation
- func (x *ListBucketOperationsResponse) GetNextPageToken() string
- func (x *ListBucketOperationsResponse) GetUnreachable() []string
- func (*ListBucketOperationsResponse) ProtoMessage()
- func (x *ListBucketOperationsResponse) ProtoReflect() protoreflect.Message
- func (x *ListBucketOperationsResponse) Reset()
- func (x *ListBucketOperationsResponse) String() string
- type ListJobsRequest
- func (*ListJobsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListJobsRequest) GetFilter() string
- func (x *ListJobsRequest) GetOrderBy() string
- func (x *ListJobsRequest) GetPageSize() int32
- func (x *ListJobsRequest) GetPageToken() string
- func (x *ListJobsRequest) GetParent() string
- func (*ListJobsRequest) ProtoMessage()
- func (x *ListJobsRequest) ProtoReflect() protoreflect.Message
- func (x *ListJobsRequest) Reset()
- func (x *ListJobsRequest) String() string
- type ListJobsResponse
- func (*ListJobsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListJobsResponse) GetJobs() []*Job
- func (x *ListJobsResponse) GetNextPageToken() string
- func (x *ListJobsResponse) GetUnreachable() []string
- func (*ListJobsResponse) ProtoMessage()
- func (x *ListJobsResponse) ProtoReflect() protoreflect.Message
- func (x *ListJobsResponse) Reset()
- func (x *ListJobsResponse) String() string
- type LoggingConfig
- func (*LoggingConfig) Descriptor() ([]byte, []int)deprecated
- func (x *LoggingConfig) GetLogActionStates() []LoggingConfig_LoggableActionState
- func (x *LoggingConfig) GetLogActions() []LoggingConfig_LoggableAction
- func (*LoggingConfig) ProtoMessage()
- func (x *LoggingConfig) ProtoReflect() protoreflect.Message
- func (x *LoggingConfig) Reset()
- func (x *LoggingConfig) String() string
- type LoggingConfig_LoggableAction
- func (LoggingConfig_LoggableAction) Descriptor() protoreflect.EnumDescriptor
- func (x LoggingConfig_LoggableAction) Enum() *LoggingConfig_LoggableAction
- func (LoggingConfig_LoggableAction) EnumDescriptor() ([]byte, []int)deprecated
- func (x LoggingConfig_LoggableAction) Number() protoreflect.EnumNumber
- func (x LoggingConfig_LoggableAction) String() string
- func (LoggingConfig_LoggableAction) Type() protoreflect.EnumType
- type LoggingConfig_LoggableActionState
- func (LoggingConfig_LoggableActionState) Descriptor() protoreflect.EnumDescriptor
- func (x LoggingConfig_LoggableActionState) Enum() *LoggingConfig_LoggableActionState
- func (LoggingConfig_LoggableActionState) EnumDescriptor() ([]byte, []int)deprecated
- func (x LoggingConfig_LoggableActionState) Number() protoreflect.EnumNumber
- func (x LoggingConfig_LoggableActionState) String() string
- func (LoggingConfig_LoggableActionState) Type() protoreflect.EnumType
- type Manifest
- type ObjectCustomContextPayload
- func (*ObjectCustomContextPayload) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectCustomContextPayload) GetValue() string
- func (*ObjectCustomContextPayload) ProtoMessage()
- func (x *ObjectCustomContextPayload) ProtoReflect() protoreflect.Message
- func (x *ObjectCustomContextPayload) Reset()
- func (x *ObjectCustomContextPayload) String() string
- type ObjectRetention
- func (*ObjectRetention) Descriptor() ([]byte, []int)deprecated
- func (x *ObjectRetention) GetRetainUntilTime() string
- func (x *ObjectRetention) GetRetentionMode() ObjectRetention_RetentionMode
- func (*ObjectRetention) ProtoMessage()
- func (x *ObjectRetention) ProtoReflect() protoreflect.Message
- func (x *ObjectRetention) Reset()
- func (x *ObjectRetention) String() string
- type ObjectRetention_RetentionMode
- func (ObjectRetention_RetentionMode) Descriptor() protoreflect.EnumDescriptor
- func (x ObjectRetention_RetentionMode) Enum() *ObjectRetention_RetentionMode
- func (ObjectRetention_RetentionMode) EnumDescriptor() ([]byte, []int)deprecated
- func (x ObjectRetention_RetentionMode) Number() protoreflect.EnumNumber
- func (x ObjectRetention_RetentionMode) String() string
- func (ObjectRetention_RetentionMode) Type() protoreflect.EnumType
- type OperationMetadata
- func (*OperationMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *OperationMetadata) GetApiVersion() string
- func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
- func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
- func (x *OperationMetadata) GetJob() *Job
- func (x *OperationMetadata) GetOperation() string
- func (x *OperationMetadata) GetRequestedCancellation() bool
- func (*OperationMetadata) ProtoMessage()
- func (x *OperationMetadata) ProtoReflect() protoreflect.Message
- func (x *OperationMetadata) Reset()
- func (x *OperationMetadata) String() string
- type PrefixList
- type PutMetadata
- func (*PutMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *PutMetadata) GetCacheControl() string
- func (x *PutMetadata) GetContentDisposition() string
- func (x *PutMetadata) GetContentEncoding() string
- func (x *PutMetadata) GetContentLanguage() string
- func (x *PutMetadata) GetContentType() string
- func (x *PutMetadata) GetCustomMetadata() map[string]string
- func (x *PutMetadata) GetCustomTime() string
- func (x *PutMetadata) GetObjectRetention() *ObjectRetention
- func (*PutMetadata) ProtoMessage()
- func (x *PutMetadata) ProtoReflect() protoreflect.Message
- func (x *PutMetadata) Reset()
- func (x *PutMetadata) String() string
- type PutObjectHold
- func (*PutObjectHold) Descriptor() ([]byte, []int)deprecated
- func (x *PutObjectHold) GetEventBasedHold() PutObjectHold_HoldStatus
- func (x *PutObjectHold) GetTemporaryHold() PutObjectHold_HoldStatus
- func (*PutObjectHold) ProtoMessage()
- func (x *PutObjectHold) ProtoReflect() protoreflect.Message
- func (x *PutObjectHold) Reset()
- func (x *PutObjectHold) String() string
- type PutObjectHold_HoldStatus
- func (PutObjectHold_HoldStatus) Descriptor() protoreflect.EnumDescriptor
- func (x PutObjectHold_HoldStatus) Enum() *PutObjectHold_HoldStatus
- func (PutObjectHold_HoldStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x PutObjectHold_HoldStatus) Number() protoreflect.EnumNumber
- func (x PutObjectHold_HoldStatus) String() string
- func (PutObjectHold_HoldStatus) Type() protoreflect.EnumType
- type RewriteObject
- type StorageBatchOperationsClient
- type StorageBatchOperationsServer
- type UnimplementedStorageBatchOperationsServer
- func (UnimplementedStorageBatchOperationsServer) CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)
- func (UnimplementedStorageBatchOperationsServer) CreateJob(context.Context, *CreateJobRequest) (*longrunningpb.Operation, error)
- func (UnimplementedStorageBatchOperationsServer) DeleteJob(context.Context, *DeleteJobRequest) (*emptypb.Empty, error)
- func (UnimplementedStorageBatchOperationsServer) GetBucketOperation(context.Context, *GetBucketOperationRequest) (*BucketOperation, error)
- func (UnimplementedStorageBatchOperationsServer) GetJob(context.Context, *GetJobRequest) (*Job, error)
- func (UnimplementedStorageBatchOperationsServer) ListBucketOperations(context.Context, *ListBucketOperationsRequest) (*ListBucketOperationsResponse, error)
- func (UnimplementedStorageBatchOperationsServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
- type UnsafeStorageBatchOperationsServer
- type UpdateObjectCustomContext
- func (*UpdateObjectCustomContext) Descriptor() ([]byte, []int)deprecated
- func (m *UpdateObjectCustomContext) GetAction() isUpdateObjectCustomContext_Action
- func (x *UpdateObjectCustomContext) GetClearAll() bool
- func (x *UpdateObjectCustomContext) GetCustomContextUpdates() *CustomContextUpdates
- func (*UpdateObjectCustomContext) ProtoMessage()
- func (x *UpdateObjectCustomContext) ProtoReflect() protoreflect.Message
- func (x *UpdateObjectCustomContext) Reset()
- func (x *UpdateObjectCustomContext) String() string
- type UpdateObjectCustomContext_ClearAll
- type UpdateObjectCustomContext_CustomContextUpdates
Constants ¶
const ( StorageBatchOperations_ListJobs_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/ListJobs" StorageBatchOperations_GetJob_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/GetJob" StorageBatchOperations_CreateJob_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/CreateJob" StorageBatchOperations_DeleteJob_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/DeleteJob" StorageBatchOperations_CancelJob_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/CancelJob" StorageBatchOperations_ListBucketOperations_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/ListBucketOperations" StorageBatchOperations_GetBucketOperation_FullMethodName = "/google.cloud.storagebatchoperations.v1.StorageBatchOperations/GetBucketOperation" )
Variables ¶
var ( Job_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "RUNNING", 2: "SUCCEEDED", 3: "CANCELED", 4: "FAILED", 5: "QUEUED", } Job_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "RUNNING": 1, "SUCCEEDED": 2, "CANCELED": 3, "FAILED": 4, "QUEUED": 5, } )
Enum value maps for Job_State.
var ( BucketOperation_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "QUEUED", 2: "RUNNING", 3: "SUCCEEDED", 4: "CANCELED", 5: "FAILED", } BucketOperation_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "QUEUED": 1, "RUNNING": 2, "SUCCEEDED": 3, "CANCELED": 4, "FAILED": 5, } )
Enum value maps for BucketOperation_State.
var ( PutObjectHold_HoldStatus_name = map[int32]string{ 0: "HOLD_STATUS_UNSPECIFIED", 1: "SET", 2: "UNSET", } PutObjectHold_HoldStatus_value = map[string]int32{ "HOLD_STATUS_UNSPECIFIED": 0, "SET": 1, "UNSET": 2, } )
Enum value maps for PutObjectHold_HoldStatus.
var ( ObjectRetention_RetentionMode_name = map[int32]string{ 0: "RETENTION_MODE_UNSPECIFIED", 1: "LOCKED", 2: "UNLOCKED", } ObjectRetention_RetentionMode_value = map[string]int32{ "RETENTION_MODE_UNSPECIFIED": 0, "LOCKED": 1, "UNLOCKED": 2, } )
Enum value maps for ObjectRetention_RetentionMode.
var ( LoggingConfig_LoggableAction_name = map[int32]string{ 0: "LOGGABLE_ACTION_UNSPECIFIED", 6: "TRANSFORM", } LoggingConfig_LoggableAction_value = map[string]int32{ "LOGGABLE_ACTION_UNSPECIFIED": 0, "TRANSFORM": 6, } )
Enum value maps for LoggingConfig_LoggableAction.
var ( LoggingConfig_LoggableActionState_name = map[int32]string{ 0: "LOGGABLE_ACTION_STATE_UNSPECIFIED", 1: "SUCCEEDED", 2: "FAILED", } LoggingConfig_LoggableActionState_value = map[string]int32{ "LOGGABLE_ACTION_STATE_UNSPECIFIED": 0, "SUCCEEDED": 1, "FAILED": 2, } )
Enum value maps for LoggingConfig_LoggableActionState.
var File_google_cloud_storagebatchoperations_v1_storage_batch_operations_proto protoreflect.FileDescriptor
var File_google_cloud_storagebatchoperations_v1_storage_batch_operations_types_proto protoreflect.FileDescriptor
var StorageBatchOperations_ServiceDesc = grpc.ServiceDesc{ ServiceName: "google.cloud.storagebatchoperations.v1.StorageBatchOperations", HandlerType: (*StorageBatchOperationsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListJobs", Handler: _StorageBatchOperations_ListJobs_Handler, }, { MethodName: "GetJob", Handler: _StorageBatchOperations_GetJob_Handler, }, { MethodName: "CreateJob", Handler: _StorageBatchOperations_CreateJob_Handler, }, { MethodName: "DeleteJob", Handler: _StorageBatchOperations_DeleteJob_Handler, }, { MethodName: "CancelJob", Handler: _StorageBatchOperations_CancelJob_Handler, }, { MethodName: "ListBucketOperations", Handler: _StorageBatchOperations_ListBucketOperations_Handler, }, { MethodName: "GetBucketOperation", Handler: _StorageBatchOperations_GetBucketOperation_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "google/cloud/storagebatchoperations/v1/storage_batch_operations.proto", }
StorageBatchOperations_ServiceDesc is the grpc.ServiceDesc for StorageBatchOperations service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterStorageBatchOperationsServer ¶
func RegisterStorageBatchOperationsServer(s grpc.ServiceRegistrar, srv StorageBatchOperationsServer)
Types ¶
type BucketList ¶
type BucketList struct {
// Required. List of buckets and their objects to be transformed. Currently,
// only one bucket configuration is supported. If multiple buckets are
// specified, an error will be returned.
Buckets []*BucketList_Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`
// contains filtered or unexported fields
}
Describes list of buckets and their objects to be transformed.
func (*BucketList) Descriptor
deprecated
func (*BucketList) Descriptor() ([]byte, []int)
Deprecated: Use BucketList.ProtoReflect.Descriptor instead.
func (*BucketList) GetBuckets ¶
func (x *BucketList) GetBuckets() []*BucketList_Bucket
func (*BucketList) ProtoMessage ¶
func (*BucketList) ProtoMessage()
func (*BucketList) ProtoReflect ¶
func (x *BucketList) ProtoReflect() protoreflect.Message
func (*BucketList) Reset ¶
func (x *BucketList) Reset()
func (*BucketList) String ¶
func (x *BucketList) String() string
type BucketList_Bucket ¶
type BucketList_Bucket struct {
// Required. Bucket name for the objects to be transformed.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Specifies objects to be transformed.
//
// Types that are assignable to ObjectConfiguration:
//
// *BucketList_Bucket_PrefixList
// *BucketList_Bucket_Manifest
ObjectConfiguration isBucketList_Bucket_ObjectConfiguration `protobuf_oneof:"object_configuration"`
// contains filtered or unexported fields
}
Describes configuration of a single bucket and its objects to be transformed.
func (*BucketList_Bucket) Descriptor
deprecated
func (*BucketList_Bucket) Descriptor() ([]byte, []int)
Deprecated: Use BucketList_Bucket.ProtoReflect.Descriptor instead.
func (*BucketList_Bucket) GetBucket ¶
func (x *BucketList_Bucket) GetBucket() string
func (*BucketList_Bucket) GetManifest ¶
func (x *BucketList_Bucket) GetManifest() *Manifest
func (*BucketList_Bucket) GetObjectConfiguration ¶
func (m *BucketList_Bucket) GetObjectConfiguration() isBucketList_Bucket_ObjectConfiguration
func (*BucketList_Bucket) GetPrefixList ¶
func (x *BucketList_Bucket) GetPrefixList() *PrefixList
func (*BucketList_Bucket) ProtoMessage ¶
func (*BucketList_Bucket) ProtoMessage()
func (*BucketList_Bucket) ProtoReflect ¶
func (x *BucketList_Bucket) ProtoReflect() protoreflect.Message
func (*BucketList_Bucket) Reset ¶
func (x *BucketList_Bucket) Reset()
func (*BucketList_Bucket) String ¶
func (x *BucketList_Bucket) String() string
type BucketList_Bucket_Manifest ¶
type BucketList_Bucket_Manifest struct {
// Specifies objects in a manifest file.
Manifest *Manifest `protobuf:"bytes,3,opt,name=manifest,proto3,oneof"`
}
type BucketList_Bucket_PrefixList ¶
type BucketList_Bucket_PrefixList struct {
// Specifies objects matching a prefix set.
PrefixList *PrefixList `protobuf:"bytes,2,opt,name=prefix_list,json=prefixList,proto3,oneof"`
}
type BucketOperation ¶ added in v0.3.0
type BucketOperation struct {
// Identifier. The resource name of the BucketOperation. This is defined by
// the service. Format:
// projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The bucket name of the objects to be transformed in the BucketOperation.
BucketName string `protobuf:"bytes,2,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
// Specifies objects to be transformed in the BucketOperation.
//
// Types that are assignable to ObjectConfiguration:
//
// *BucketOperation_PrefixList
// *BucketOperation_Manifest
ObjectConfiguration isBucketOperation_ObjectConfiguration `protobuf_oneof:"object_configuration"`
// Action to be performed on the objects.
//
// Types that are assignable to Transformation:
//
// *BucketOperation_PutObjectHold
// *BucketOperation_DeleteObject
// *BucketOperation_PutMetadata
// *BucketOperation_RewriteObject
// *BucketOperation_UpdateObjectCustomContext
Transformation isBucketOperation_Transformation `protobuf_oneof:"transformation"`
// Output only. The time that the BucketOperation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time that the BucketOperation was started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The time that the BucketOperation was completed.
CompleteTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
// Output only. Information about the progress of the bucket operation.
Counters *Counters `protobuf:"bytes,8,opt,name=counters,proto3" json:"counters,omitempty"`
// Output only. Summarizes errors encountered with sample error log entries.
ErrorSummaries []*ErrorSummary `protobuf:"bytes,9,rep,name=error_summaries,json=errorSummaries,proto3" json:"error_summaries,omitempty"`
// Output only. State of the BucketOperation.
State BucketOperation_State `` /* 131-byte string literal not displayed */
// contains filtered or unexported fields
}
BucketOperation represents a bucket-level breakdown of a Job.
func (*BucketOperation) Descriptor
deprecated
added in
v0.3.0
func (*BucketOperation) Descriptor() ([]byte, []int)
Deprecated: Use BucketOperation.ProtoReflect.Descriptor instead.
func (*BucketOperation) GetBucketName ¶ added in v0.3.0
func (x *BucketOperation) GetBucketName() string
func (*BucketOperation) GetCompleteTime ¶ added in v0.3.0
func (x *BucketOperation) GetCompleteTime() *timestamppb.Timestamp
func (*BucketOperation) GetCounters ¶ added in v0.3.0
func (x *BucketOperation) GetCounters() *Counters
func (*BucketOperation) GetCreateTime ¶ added in v0.3.0
func (x *BucketOperation) GetCreateTime() *timestamppb.Timestamp
func (*BucketOperation) GetDeleteObject ¶ added in v0.3.0
func (x *BucketOperation) GetDeleteObject() *DeleteObject
func (*BucketOperation) GetErrorSummaries ¶ added in v0.3.0
func (x *BucketOperation) GetErrorSummaries() []*ErrorSummary
func (*BucketOperation) GetManifest ¶ added in v0.3.0
func (x *BucketOperation) GetManifest() *Manifest
func (*BucketOperation) GetName ¶ added in v0.3.0
func (x *BucketOperation) GetName() string
func (*BucketOperation) GetObjectConfiguration ¶ added in v0.3.0
func (m *BucketOperation) GetObjectConfiguration() isBucketOperation_ObjectConfiguration
func (*BucketOperation) GetPrefixList ¶ added in v0.3.0
func (x *BucketOperation) GetPrefixList() *PrefixList
func (*BucketOperation) GetPutMetadata ¶ added in v0.3.0
func (x *BucketOperation) GetPutMetadata() *PutMetadata
func (*BucketOperation) GetPutObjectHold ¶ added in v0.3.0
func (x *BucketOperation) GetPutObjectHold() *PutObjectHold
func (*BucketOperation) GetRewriteObject ¶ added in v0.3.0
func (x *BucketOperation) GetRewriteObject() *RewriteObject
func (*BucketOperation) GetStartTime ¶ added in v0.3.0
func (x *BucketOperation) GetStartTime() *timestamppb.Timestamp
func (*BucketOperation) GetState ¶ added in v0.3.0
func (x *BucketOperation) GetState() BucketOperation_State
func (*BucketOperation) GetTransformation ¶ added in v0.3.0
func (m *BucketOperation) GetTransformation() isBucketOperation_Transformation
func (*BucketOperation) GetUpdateObjectCustomContext ¶ added in v0.4.0
func (x *BucketOperation) GetUpdateObjectCustomContext() *UpdateObjectCustomContext
func (*BucketOperation) ProtoMessage ¶ added in v0.3.0
func (*BucketOperation) ProtoMessage()
func (*BucketOperation) ProtoReflect ¶ added in v0.3.0
func (x *BucketOperation) ProtoReflect() protoreflect.Message
func (*BucketOperation) Reset ¶ added in v0.3.0
func (x *BucketOperation) Reset()
func (*BucketOperation) String ¶ added in v0.3.0
func (x *BucketOperation) String() string
type BucketOperation_DeleteObject ¶ added in v0.3.0
type BucketOperation_DeleteObject struct {
// Delete objects.
DeleteObject *DeleteObject `protobuf:"bytes,12,opt,name=delete_object,json=deleteObject,proto3,oneof"`
}
type BucketOperation_Manifest ¶ added in v0.3.0
type BucketOperation_Manifest struct {
// Specifies objects in a manifest file.
Manifest *Manifest `protobuf:"bytes,4,opt,name=manifest,proto3,oneof"`
}
type BucketOperation_PrefixList ¶ added in v0.3.0
type BucketOperation_PrefixList struct {
// Specifies objects matching a prefix set.
PrefixList *PrefixList `protobuf:"bytes,3,opt,name=prefix_list,json=prefixList,proto3,oneof"`
}
type BucketOperation_PutMetadata ¶ added in v0.3.0
type BucketOperation_PutMetadata struct {
// Updates object metadata. Allows updating fixed-key and custom metadata
// and fixed-key metadata i.e. Cache-Control, Content-Disposition,
// Content-Encoding, Content-Language, Content-Type, Custom-Time.
PutMetadata *PutMetadata `protobuf:"bytes,13,opt,name=put_metadata,json=putMetadata,proto3,oneof"`
}
type BucketOperation_PutObjectHold ¶ added in v0.3.0
type BucketOperation_PutObjectHold struct {
// Changes object hold status.
PutObjectHold *PutObjectHold `protobuf:"bytes,11,opt,name=put_object_hold,json=putObjectHold,proto3,oneof"`
}
type BucketOperation_RewriteObject ¶ added in v0.3.0
type BucketOperation_RewriteObject struct {
// Rewrite the object and updates metadata like KMS key.
RewriteObject *RewriteObject `protobuf:"bytes,14,opt,name=rewrite_object,json=rewriteObject,proto3,oneof"`
}
type BucketOperation_State ¶ added in v0.3.0
type BucketOperation_State int32
Describes state of the BucketOperation.
const ( // Default value. This value is unused. BucketOperation_STATE_UNSPECIFIED BucketOperation_State = 0 // Created but not yet started. BucketOperation_QUEUED BucketOperation_State = 1 // In progress. BucketOperation_RUNNING BucketOperation_State = 2 // Completed successfully. BucketOperation_SUCCEEDED BucketOperation_State = 3 // Cancelled by the user. BucketOperation_CANCELED BucketOperation_State = 4 // Terminated due to an unrecoverable failure. BucketOperation_FAILED BucketOperation_State = 5 )
func (BucketOperation_State) Descriptor ¶ added in v0.3.0
func (BucketOperation_State) Descriptor() protoreflect.EnumDescriptor
func (BucketOperation_State) Enum ¶ added in v0.3.0
func (x BucketOperation_State) Enum() *BucketOperation_State
func (BucketOperation_State) EnumDescriptor
deprecated
added in
v0.3.0
func (BucketOperation_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use BucketOperation_State.Descriptor instead.
func (BucketOperation_State) Number ¶ added in v0.3.0
func (x BucketOperation_State) Number() protoreflect.EnumNumber
func (BucketOperation_State) String ¶ added in v0.3.0
func (x BucketOperation_State) String() string
func (BucketOperation_State) Type ¶ added in v0.3.0
func (BucketOperation_State) Type() protoreflect.EnumType
type BucketOperation_UpdateObjectCustomContext ¶ added in v0.4.0
type BucketOperation_UpdateObjectCustomContext struct {
// Update object custom context.
UpdateObjectCustomContext *UpdateObjectCustomContext `protobuf:"bytes,15,opt,name=update_object_custom_context,json=updateObjectCustomContext,proto3,oneof"`
}
type CancelJobRequest ¶
type CancelJobRequest struct {
// Required. The `name` of the job to cancel.
// Format: projects/{project_id}/locations/global/jobs/{job_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID in case you need to retry your request. Requests with same
// `request_id` will be ignored for at least 60 minutes since the first
// request. The request ID must be a valid UUID with the exception that zero
// UUID is not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
Message for Job to Cancel
func (*CancelJobRequest) Descriptor
deprecated
func (*CancelJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use CancelJobRequest.ProtoReflect.Descriptor instead.
func (*CancelJobRequest) GetName ¶
func (x *CancelJobRequest) GetName() string
func (*CancelJobRequest) GetRequestId ¶
func (x *CancelJobRequest) GetRequestId() string
func (*CancelJobRequest) ProtoMessage ¶
func (*CancelJobRequest) ProtoMessage()
func (*CancelJobRequest) ProtoReflect ¶
func (x *CancelJobRequest) ProtoReflect() protoreflect.Message
func (*CancelJobRequest) Reset ¶
func (x *CancelJobRequest) Reset()
func (*CancelJobRequest) String ¶
func (x *CancelJobRequest) String() string
type CancelJobResponse ¶
type CancelJobResponse struct {
// contains filtered or unexported fields
}
Message for response to cancel Job.
func (*CancelJobResponse) Descriptor
deprecated
func (*CancelJobResponse) Descriptor() ([]byte, []int)
Deprecated: Use CancelJobResponse.ProtoReflect.Descriptor instead.
func (*CancelJobResponse) ProtoMessage ¶
func (*CancelJobResponse) ProtoMessage()
func (*CancelJobResponse) ProtoReflect ¶
func (x *CancelJobResponse) ProtoReflect() protoreflect.Message
func (*CancelJobResponse) Reset ¶
func (x *CancelJobResponse) Reset()
func (*CancelJobResponse) String ¶
func (x *CancelJobResponse) String() string
type Counters ¶
type Counters struct {
// Output only. Number of objects listed.
TotalObjectCount int64 `protobuf:"varint,1,opt,name=total_object_count,json=totalObjectCount,proto3" json:"total_object_count,omitempty"`
// Output only. Number of objects completed.
SucceededObjectCount int64 `protobuf:"varint,2,opt,name=succeeded_object_count,json=succeededObjectCount,proto3" json:"succeeded_object_count,omitempty"`
// Output only. Number of objects failed.
FailedObjectCount int64 `protobuf:"varint,3,opt,name=failed_object_count,json=failedObjectCount,proto3" json:"failed_object_count,omitempty"`
// Output only. Number of bytes found from source. This field is only
// populated for jobs with a prefix list object configuration.
TotalBytesFound *int64 `protobuf:"varint,4,opt,name=total_bytes_found,json=totalBytesFound,proto3,oneof" json:"total_bytes_found,omitempty"`
// contains filtered or unexported fields
}
Describes details about the progress of the job.
func (*Counters) Descriptor
deprecated
func (*Counters) GetFailedObjectCount ¶
func (*Counters) GetSucceededObjectCount ¶
func (*Counters) GetTotalBytesFound ¶ added in v0.2.0
func (*Counters) GetTotalObjectCount ¶
func (*Counters) ProtoMessage ¶
func (*Counters) ProtoMessage()
func (*Counters) ProtoReflect ¶
func (x *Counters) ProtoReflect() protoreflect.Message
type CreateJobRequest ¶
type CreateJobRequest struct {
// Required. Value for parent.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The optional `job_id` for this Job . If not
// specified, an id is generated. `job_id` should be no more than 128
// characters and must include only characters available in DNS names, as
// defined by RFC-1123.
JobId string `protobuf:"bytes,2,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
// Required. The resource being created
Job *Job `protobuf:"bytes,3,opt,name=job,proto3" json:"job,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID in case you need to retry your request. Requests with same
// `request_id` will be ignored for at least 60 minutes since the first
// request. The request ID must be a valid UUID with the exception that zero
// UUID is not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
Message for creating a Job
func (*CreateJobRequest) Descriptor
deprecated
func (*CreateJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateJobRequest.ProtoReflect.Descriptor instead.
func (*CreateJobRequest) GetJob ¶
func (x *CreateJobRequest) GetJob() *Job
func (*CreateJobRequest) GetJobId ¶
func (x *CreateJobRequest) GetJobId() string
func (*CreateJobRequest) GetParent ¶
func (x *CreateJobRequest) GetParent() string
func (*CreateJobRequest) GetRequestId ¶
func (x *CreateJobRequest) GetRequestId() string
func (*CreateJobRequest) ProtoMessage ¶
func (*CreateJobRequest) ProtoMessage()
func (*CreateJobRequest) ProtoReflect ¶
func (x *CreateJobRequest) ProtoReflect() protoreflect.Message
func (*CreateJobRequest) Reset ¶
func (x *CreateJobRequest) Reset()
func (*CreateJobRequest) String ¶
func (x *CreateJobRequest) String() string
type CustomContextUpdates ¶ added in v0.4.0
type CustomContextUpdates struct {
// Optional. Insert or update the existing custom contexts.
Updates map[string]*ObjectCustomContextPayload `` /* 155-byte string literal not displayed */
// Optional. Custom contexts to clear by key.
// A key cannot be present in both `updates` and `keys_to_clear`.
KeysToClear []string `protobuf:"bytes,2,rep,name=keys_to_clear,json=keysToClear,proto3" json:"keys_to_clear,omitempty"`
// contains filtered or unexported fields
}
Describes a collection of updates to apply to custom contexts identified by key.
func (*CustomContextUpdates) Descriptor
deprecated
added in
v0.4.0
func (*CustomContextUpdates) Descriptor() ([]byte, []int)
Deprecated: Use CustomContextUpdates.ProtoReflect.Descriptor instead.
func (*CustomContextUpdates) GetKeysToClear ¶ added in v0.4.0
func (x *CustomContextUpdates) GetKeysToClear() []string
func (*CustomContextUpdates) GetUpdates ¶ added in v0.4.0
func (x *CustomContextUpdates) GetUpdates() map[string]*ObjectCustomContextPayload
func (*CustomContextUpdates) ProtoMessage ¶ added in v0.4.0
func (*CustomContextUpdates) ProtoMessage()
func (*CustomContextUpdates) ProtoReflect ¶ added in v0.4.0
func (x *CustomContextUpdates) ProtoReflect() protoreflect.Message
func (*CustomContextUpdates) Reset ¶ added in v0.4.0
func (x *CustomContextUpdates) Reset()
func (*CustomContextUpdates) String ¶ added in v0.4.0
func (x *CustomContextUpdates) String() string
type DeleteJobRequest ¶
type DeleteJobRequest struct {
// Required. The `name` of the job to delete.
// Format: projects/{project_id}/locations/global/jobs/{job_id} .
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID in case you need to retry your request. Requests with same
// `request_id` will be ignored for at least 60 minutes since the first
// request. The request ID must be a valid UUID with the exception that zero
// UUID is not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set to true, any child bucket operations of the job will also
// be deleted. Highly recommended to be set to true by all clients. Users
// cannot mutate bucket operations directly, so only the jobs.delete
// permission is required to delete a job (and its child bucket operations).
Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
Message for deleting a Job
func (*DeleteJobRequest) Descriptor
deprecated
func (*DeleteJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.
func (*DeleteJobRequest) GetForce ¶ added in v0.3.0
func (x *DeleteJobRequest) GetForce() bool
func (*DeleteJobRequest) GetName ¶
func (x *DeleteJobRequest) GetName() string
func (*DeleteJobRequest) GetRequestId ¶
func (x *DeleteJobRequest) GetRequestId() string
func (*DeleteJobRequest) ProtoMessage ¶
func (*DeleteJobRequest) ProtoMessage()
func (*DeleteJobRequest) ProtoReflect ¶
func (x *DeleteJobRequest) ProtoReflect() protoreflect.Message
func (*DeleteJobRequest) Reset ¶
func (x *DeleteJobRequest) Reset()
func (*DeleteJobRequest) String ¶
func (x *DeleteJobRequest) String() string
type DeleteObject ¶
type DeleteObject struct {
// Required. Controls deletion behavior when versioning is enabled for the
// object's bucket. If true both live and noncurrent objects will be
// permanently deleted. Otherwise live objects in versioned buckets will
// become noncurrent and objects that were already noncurrent will be skipped.
// This setting doesn't have any impact on the Soft Delete feature. All
// objects deleted by this service can be be restored for the duration of the
// Soft Delete retention duration if enabled. If enabled and the manifest
// doesn't specify an object's generation, a GetObjectMetadata call (a Class B
// operation) will be made to determine the live object generation.
PermanentObjectDeletionEnabled bool `` /* 156-byte string literal not displayed */
// contains filtered or unexported fields
}
Describes options to delete an object.
func (*DeleteObject) Descriptor
deprecated
func (*DeleteObject) Descriptor() ([]byte, []int)
Deprecated: Use DeleteObject.ProtoReflect.Descriptor instead.
func (*DeleteObject) GetPermanentObjectDeletionEnabled ¶
func (x *DeleteObject) GetPermanentObjectDeletionEnabled() bool
func (*DeleteObject) ProtoMessage ¶
func (*DeleteObject) ProtoMessage()
func (*DeleteObject) ProtoReflect ¶
func (x *DeleteObject) ProtoReflect() protoreflect.Message
func (*DeleteObject) Reset ¶
func (x *DeleteObject) Reset()
func (*DeleteObject) String ¶
func (x *DeleteObject) String() string
type ErrorLogEntry ¶
type ErrorLogEntry struct {
// Required. Output only. Object URL. e.g. gs://my_bucket/object.txt
ObjectUri string `protobuf:"bytes,1,opt,name=object_uri,json=objectUri,proto3" json:"object_uri,omitempty"`
// Optional. Output only. At most 5 error log entries are recorded for a given
// error code for a job.
ErrorDetails []string `protobuf:"bytes,3,rep,name=error_details,json=errorDetails,proto3" json:"error_details,omitempty"`
// contains filtered or unexported fields
}
An entry describing an error that has occurred.
func (*ErrorLogEntry) Descriptor
deprecated
func (*ErrorLogEntry) Descriptor() ([]byte, []int)
Deprecated: Use ErrorLogEntry.ProtoReflect.Descriptor instead.
func (*ErrorLogEntry) GetErrorDetails ¶
func (x *ErrorLogEntry) GetErrorDetails() []string
func (*ErrorLogEntry) GetObjectUri ¶
func (x *ErrorLogEntry) GetObjectUri() string
func (*ErrorLogEntry) ProtoMessage ¶
func (*ErrorLogEntry) ProtoMessage()
func (*ErrorLogEntry) ProtoReflect ¶
func (x *ErrorLogEntry) ProtoReflect() protoreflect.Message
func (*ErrorLogEntry) Reset ¶
func (x *ErrorLogEntry) Reset()
func (*ErrorLogEntry) String ¶
func (x *ErrorLogEntry) String() string
type ErrorSummary ¶
type ErrorSummary struct {
// Required. The canonical error code.
ErrorCode code.Code `protobuf:"varint,1,opt,name=error_code,json=errorCode,proto3,enum=google.rpc.Code" json:"error_code,omitempty"`
// Required. Number of errors encountered per `error_code`.
ErrorCount int64 `protobuf:"varint,2,opt,name=error_count,json=errorCount,proto3" json:"error_count,omitempty"`
// Required. Sample error logs.
ErrorLogEntries []*ErrorLogEntry `protobuf:"bytes,3,rep,name=error_log_entries,json=errorLogEntries,proto3" json:"error_log_entries,omitempty"`
// contains filtered or unexported fields
}
A summary of errors by error code, plus a count and sample error log entries.
func (*ErrorSummary) Descriptor
deprecated
func (*ErrorSummary) Descriptor() ([]byte, []int)
Deprecated: Use ErrorSummary.ProtoReflect.Descriptor instead.
func (*ErrorSummary) GetErrorCode ¶
func (x *ErrorSummary) GetErrorCode() code.Code
func (*ErrorSummary) GetErrorCount ¶
func (x *ErrorSummary) GetErrorCount() int64
func (*ErrorSummary) GetErrorLogEntries ¶
func (x *ErrorSummary) GetErrorLogEntries() []*ErrorLogEntry
func (*ErrorSummary) ProtoMessage ¶
func (*ErrorSummary) ProtoMessage()
func (*ErrorSummary) ProtoReflect ¶
func (x *ErrorSummary) ProtoReflect() protoreflect.Message
func (*ErrorSummary) Reset ¶
func (x *ErrorSummary) Reset()
func (*ErrorSummary) String ¶
func (x *ErrorSummary) String() string
type GetBucketOperationRequest ¶ added in v0.3.0
type GetBucketOperationRequest struct {
// Required. `name` of the bucket operation to retrieve.
// Format:
// projects/{project_id}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Message for getting a BucketOperation.
func (*GetBucketOperationRequest) Descriptor
deprecated
added in
v0.3.0
func (*GetBucketOperationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBucketOperationRequest.ProtoReflect.Descriptor instead.
func (*GetBucketOperationRequest) GetName ¶ added in v0.3.0
func (x *GetBucketOperationRequest) GetName() string
func (*GetBucketOperationRequest) ProtoMessage ¶ added in v0.3.0
func (*GetBucketOperationRequest) ProtoMessage()
func (*GetBucketOperationRequest) ProtoReflect ¶ added in v0.3.0
func (x *GetBucketOperationRequest) ProtoReflect() protoreflect.Message
func (*GetBucketOperationRequest) Reset ¶ added in v0.3.0
func (x *GetBucketOperationRequest) Reset()
func (*GetBucketOperationRequest) String ¶ added in v0.3.0
func (x *GetBucketOperationRequest) String() string
type GetJobRequest ¶
type GetJobRequest struct {
// Required. `name` of the job to retrieve.
// Format: projects/{project_id}/locations/global/jobs/{job_id} .
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Message for getting a Job
func (*GetJobRequest) Descriptor
deprecated
func (*GetJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.
func (*GetJobRequest) GetName ¶
func (x *GetJobRequest) GetName() string
func (*GetJobRequest) ProtoMessage ¶
func (*GetJobRequest) ProtoMessage()
func (*GetJobRequest) ProtoReflect ¶
func (x *GetJobRequest) ProtoReflect() protoreflect.Message
func (*GetJobRequest) Reset ¶
func (x *GetJobRequest) Reset()
func (*GetJobRequest) String ¶
func (x *GetJobRequest) String() string
type Job ¶
type Job struct {
// Identifier. The resource name of the Job. job_id is unique
// within the project, that is either set by the customer or
// defined by the service. Format:
// projects/{project}/locations/global/jobs/{job_id} .
// For example: "projects/123456/locations/global/jobs/job01".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. A description provided by the user for the job. Its max length is
// 1024 bytes when Unicode-encoded.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Specifies objects to be transformed.
//
// Types that are assignable to Source:
//
// *Job_BucketList
Source isJob_Source `protobuf_oneof:"source"`
// Operation to be performed on the objects.
//
// Types that are assignable to Transformation:
//
// *Job_PutObjectHold
// *Job_DeleteObject
// *Job_PutMetadata
// *Job_RewriteObject
// *Job_UpdateObjectCustomContext
Transformation isJob_Transformation `protobuf_oneof:"transformation"`
// Optional. Logging configuration.
LoggingConfig *LoggingConfig `protobuf:"bytes,9,opt,name=logging_config,json=loggingConfig,proto3" json:"logging_config,omitempty"`
// Output only. The time that the job was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time that the job was scheduled.
ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
// Output only. The time that the job was completed.
CompleteTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
// Output only. Information about the progress of the job.
Counters *Counters `protobuf:"bytes,13,opt,name=counters,proto3" json:"counters,omitempty"`
// Output only. Summarizes errors encountered with sample error log entries.
ErrorSummaries []*ErrorSummary `protobuf:"bytes,14,rep,name=error_summaries,json=errorSummaries,proto3" json:"error_summaries,omitempty"`
// Output only. State of the job.
State Job_State `protobuf:"varint,15,opt,name=state,proto3,enum=google.cloud.storagebatchoperations.v1.Job_State" json:"state,omitempty"`
// Optional. If true, the job will run in dry run mode, returning the total
// object count and, if the object configuration is a prefix list, the bytes
// found from source. No transformations will be performed.
DryRun bool `protobuf:"varint,22,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// Output only. If true, this Job operates on multiple buckets. Multibucket
// jobs are subject to different quota limits than single-bucket jobs.
IsMultiBucketJob bool `protobuf:"varint,24,opt,name=is_multi_bucket_job,json=isMultiBucketJob,proto3" json:"is_multi_bucket_job,omitempty"`
// contains filtered or unexported fields
}
The Storage Batch Operations Job description.
func (*Job) Descriptor
deprecated
func (*Job) GetBucketList ¶
func (x *Job) GetBucketList() *BucketList
func (*Job) GetCompleteTime ¶
func (x *Job) GetCompleteTime() *timestamppb.Timestamp
func (*Job) GetCounters ¶
func (*Job) GetCreateTime ¶
func (x *Job) GetCreateTime() *timestamppb.Timestamp
func (*Job) GetDeleteObject ¶
func (x *Job) GetDeleteObject() *DeleteObject
func (*Job) GetDescription ¶
func (*Job) GetErrorSummaries ¶
func (x *Job) GetErrorSummaries() []*ErrorSummary
func (*Job) GetIsMultiBucketJob ¶ added in v0.3.0
func (*Job) GetLoggingConfig ¶
func (x *Job) GetLoggingConfig() *LoggingConfig
func (*Job) GetPutMetadata ¶
func (x *Job) GetPutMetadata() *PutMetadata
func (*Job) GetPutObjectHold ¶
func (x *Job) GetPutObjectHold() *PutObjectHold
func (*Job) GetRewriteObject ¶
func (x *Job) GetRewriteObject() *RewriteObject
func (*Job) GetScheduleTime ¶
func (x *Job) GetScheduleTime() *timestamppb.Timestamp
func (*Job) GetTransformation ¶
func (m *Job) GetTransformation() isJob_Transformation
func (*Job) GetUpdateObjectCustomContext ¶ added in v0.4.0
func (x *Job) GetUpdateObjectCustomContext() *UpdateObjectCustomContext
func (*Job) ProtoMessage ¶
func (*Job) ProtoMessage()
func (*Job) ProtoReflect ¶
func (x *Job) ProtoReflect() protoreflect.Message
type Job_BucketList ¶
type Job_BucketList struct {
// Specifies a list of buckets and their objects to be transformed.
BucketList *BucketList `protobuf:"bytes,19,opt,name=bucket_list,json=bucketList,proto3,oneof"`
}
type Job_DeleteObject ¶
type Job_DeleteObject struct {
// Delete objects.
DeleteObject *DeleteObject `protobuf:"bytes,6,opt,name=delete_object,json=deleteObject,proto3,oneof"`
}
type Job_PutMetadata ¶
type Job_PutMetadata struct {
// Updates object metadata. Allows updating fixed-key and custom metadata
// and fixed-key metadata i.e. Cache-Control, Content-Disposition,
// Content-Encoding, Content-Language, Content-Type, Custom-Time.
PutMetadata *PutMetadata `protobuf:"bytes,8,opt,name=put_metadata,json=putMetadata,proto3,oneof"`
}
type Job_PutObjectHold ¶
type Job_PutObjectHold struct {
// Changes object hold status.
PutObjectHold *PutObjectHold `protobuf:"bytes,5,opt,name=put_object_hold,json=putObjectHold,proto3,oneof"`
}
type Job_RewriteObject ¶
type Job_RewriteObject struct {
// Rewrite the object and updates metadata like KMS key.
RewriteObject *RewriteObject `protobuf:"bytes,20,opt,name=rewrite_object,json=rewriteObject,proto3,oneof"`
}
type Job_State ¶
type Job_State int32
Describes state of a job.
const ( // Default value. This value is unused. Job_STATE_UNSPECIFIED Job_State = 0 // In progress. Job_RUNNING Job_State = 1 // Completed successfully. Job_SUCCEEDED Job_State = 2 // Cancelled by the user. Job_CANCELED Job_State = 3 // Terminated due to an unrecoverable failure. Job_FAILED Job_State = 4 // Queued but not yet started. Job_QUEUED Job_State = 5 )
func (Job_State) Descriptor ¶
func (Job_State) Descriptor() protoreflect.EnumDescriptor
func (Job_State) EnumDescriptor
deprecated
func (Job_State) Number ¶
func (x Job_State) Number() protoreflect.EnumNumber
func (Job_State) Type ¶
func (Job_State) Type() protoreflect.EnumType
type Job_UpdateObjectCustomContext ¶ added in v0.4.0
type Job_UpdateObjectCustomContext struct {
// Update object custom context.
UpdateObjectCustomContext *UpdateObjectCustomContext `protobuf:"bytes,23,opt,name=update_object_custom_context,json=updateObjectCustomContext,proto3,oneof"`
}
type ListBucketOperationsRequest ¶ added in v0.3.0
type ListBucketOperationsRequest struct {
// Required. Format: projects/{project_id}/locations/global/jobs/{job_id}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Filters results as defined by https://google.aip.dev/160.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The list page size. Default page size is 100.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The list page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Field to sort by. Supported fields are name, create_time.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
Message for request to list BucketOperations
func (*ListBucketOperationsRequest) Descriptor
deprecated
added in
v0.3.0
func (*ListBucketOperationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketOperationsRequest.ProtoReflect.Descriptor instead.
func (*ListBucketOperationsRequest) GetFilter ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) GetFilter() string
func (*ListBucketOperationsRequest) GetOrderBy ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) GetOrderBy() string
func (*ListBucketOperationsRequest) GetPageSize ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) GetPageSize() int32
func (*ListBucketOperationsRequest) GetPageToken ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) GetPageToken() string
func (*ListBucketOperationsRequest) GetParent ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) GetParent() string
func (*ListBucketOperationsRequest) ProtoMessage ¶ added in v0.3.0
func (*ListBucketOperationsRequest) ProtoMessage()
func (*ListBucketOperationsRequest) ProtoReflect ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) ProtoReflect() protoreflect.Message
func (*ListBucketOperationsRequest) Reset ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) Reset()
func (*ListBucketOperationsRequest) String ¶ added in v0.3.0
func (x *ListBucketOperationsRequest) String() string
type ListBucketOperationsResponse ¶ added in v0.3.0
type ListBucketOperationsResponse struct {
// A list of storage batch bucket operations.
BucketOperations []*BucketOperation `protobuf:"bytes,1,rep,name=bucket_operations,json=bucketOperations,proto3" json:"bucket_operations,omitempty"`
// A token identifying a page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Message for response to listing BucketOperations
func (*ListBucketOperationsResponse) Descriptor
deprecated
added in
v0.3.0
func (*ListBucketOperationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketOperationsResponse.ProtoReflect.Descriptor instead.
func (*ListBucketOperationsResponse) GetBucketOperations ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) GetBucketOperations() []*BucketOperation
func (*ListBucketOperationsResponse) GetNextPageToken ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) GetNextPageToken() string
func (*ListBucketOperationsResponse) GetUnreachable ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) GetUnreachable() []string
func (*ListBucketOperationsResponse) ProtoMessage ¶ added in v0.3.0
func (*ListBucketOperationsResponse) ProtoMessage()
func (*ListBucketOperationsResponse) ProtoReflect ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) ProtoReflect() protoreflect.Message
func (*ListBucketOperationsResponse) Reset ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) Reset()
func (*ListBucketOperationsResponse) String ¶ added in v0.3.0
func (x *ListBucketOperationsResponse) String() string
type ListJobsRequest ¶
type ListJobsRequest struct {
// Required. Format: projects/{project_id}/locations/global.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Filters results as defined by https://google.aip.dev/160.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The list page size. default page size is 100.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The list page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Field to sort by. Supported fields are name, create_time.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
Message for request to list Jobs
func (*ListJobsRequest) Descriptor
deprecated
func (*ListJobsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.
func (*ListJobsRequest) GetFilter ¶
func (x *ListJobsRequest) GetFilter() string
func (*ListJobsRequest) GetOrderBy ¶
func (x *ListJobsRequest) GetOrderBy() string
func (*ListJobsRequest) GetPageSize ¶
func (x *ListJobsRequest) GetPageSize() int32
func (*ListJobsRequest) GetPageToken ¶
func (x *ListJobsRequest) GetPageToken() string
func (*ListJobsRequest) GetParent ¶
func (x *ListJobsRequest) GetParent() string
func (*ListJobsRequest) ProtoMessage ¶
func (*ListJobsRequest) ProtoMessage()
func (*ListJobsRequest) ProtoReflect ¶
func (x *ListJobsRequest) ProtoReflect() protoreflect.Message
func (*ListJobsRequest) Reset ¶
func (x *ListJobsRequest) Reset()
func (*ListJobsRequest) String ¶
func (x *ListJobsRequest) String() string
type ListJobsResponse ¶
type ListJobsResponse struct {
// A list of storage batch jobs.
Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
// A token identifying a page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Message for response to listing Jobs
func (*ListJobsResponse) Descriptor
deprecated
func (*ListJobsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.
func (*ListJobsResponse) GetJobs ¶
func (x *ListJobsResponse) GetJobs() []*Job
func (*ListJobsResponse) GetNextPageToken ¶
func (x *ListJobsResponse) GetNextPageToken() string
func (*ListJobsResponse) GetUnreachable ¶
func (x *ListJobsResponse) GetUnreachable() []string
func (*ListJobsResponse) ProtoMessage ¶
func (*ListJobsResponse) ProtoMessage()
func (*ListJobsResponse) ProtoReflect ¶
func (x *ListJobsResponse) ProtoReflect() protoreflect.Message
func (*ListJobsResponse) Reset ¶
func (x *ListJobsResponse) Reset()
func (*ListJobsResponse) String ¶
func (x *ListJobsResponse) String() string
type LoggingConfig ¶
type LoggingConfig struct {
// Required. Specifies the actions to be logged.
LogActions []LoggingConfig_LoggableAction `` /* 172-byte string literal not displayed */
// Required. States in which Action are logged.If empty, no logs are
// generated.
LogActionStates []LoggingConfig_LoggableActionState `` /* 194-byte string literal not displayed */
// contains filtered or unexported fields
}
Specifies the Cloud Logging behavior.
func (*LoggingConfig) Descriptor
deprecated
func (*LoggingConfig) Descriptor() ([]byte, []int)
Deprecated: Use LoggingConfig.ProtoReflect.Descriptor instead.
func (*LoggingConfig) GetLogActionStates ¶
func (x *LoggingConfig) GetLogActionStates() []LoggingConfig_LoggableActionState
func (*LoggingConfig) GetLogActions ¶
func (x *LoggingConfig) GetLogActions() []LoggingConfig_LoggableAction
func (*LoggingConfig) ProtoMessage ¶
func (*LoggingConfig) ProtoMessage()
func (*LoggingConfig) ProtoReflect ¶
func (x *LoggingConfig) ProtoReflect() protoreflect.Message
func (*LoggingConfig) Reset ¶
func (x *LoggingConfig) Reset()
func (*LoggingConfig) String ¶
func (x *LoggingConfig) String() string
type LoggingConfig_LoggableAction ¶
type LoggingConfig_LoggableAction int32
Loggable actions types.
const ( // Illegal value, to avoid allowing a default. LoggingConfig_LOGGABLE_ACTION_UNSPECIFIED LoggingConfig_LoggableAction = 0 // The corresponding transform action in this job. LoggingConfig_TRANSFORM LoggingConfig_LoggableAction = 6 )
func (LoggingConfig_LoggableAction) Descriptor ¶
func (LoggingConfig_LoggableAction) Descriptor() protoreflect.EnumDescriptor
func (LoggingConfig_LoggableAction) Enum ¶
func (x LoggingConfig_LoggableAction) Enum() *LoggingConfig_LoggableAction
func (LoggingConfig_LoggableAction) EnumDescriptor
deprecated
func (LoggingConfig_LoggableAction) EnumDescriptor() ([]byte, []int)
Deprecated: Use LoggingConfig_LoggableAction.Descriptor instead.
func (LoggingConfig_LoggableAction) Number ¶
func (x LoggingConfig_LoggableAction) Number() protoreflect.EnumNumber
func (LoggingConfig_LoggableAction) String ¶
func (x LoggingConfig_LoggableAction) String() string
func (LoggingConfig_LoggableAction) Type ¶
func (LoggingConfig_LoggableAction) Type() protoreflect.EnumType
type LoggingConfig_LoggableActionState ¶
type LoggingConfig_LoggableActionState int32
Loggable action states filter.
const ( // Illegal value, to avoid allowing a default. LoggingConfig_LOGGABLE_ACTION_STATE_UNSPECIFIED LoggingConfig_LoggableActionState = 0 // `LoggableAction` completed successfully. `SUCCEEDED` actions are // logged as [INFO][google.logging.type.LogSeverity.INFO]. LoggingConfig_SUCCEEDED LoggingConfig_LoggableActionState = 1 // `LoggableAction` terminated in an error state. `FAILED` actions // are logged as [ERROR][google.logging.type.LogSeverity.ERROR]. LoggingConfig_FAILED LoggingConfig_LoggableActionState = 2 )
func (LoggingConfig_LoggableActionState) Descriptor ¶
func (LoggingConfig_LoggableActionState) Descriptor() protoreflect.EnumDescriptor
func (LoggingConfig_LoggableActionState) Enum ¶
func (x LoggingConfig_LoggableActionState) Enum() *LoggingConfig_LoggableActionState
func (LoggingConfig_LoggableActionState) EnumDescriptor
deprecated
func (LoggingConfig_LoggableActionState) EnumDescriptor() ([]byte, []int)
Deprecated: Use LoggingConfig_LoggableActionState.Descriptor instead.
func (LoggingConfig_LoggableActionState) Number ¶
func (x LoggingConfig_LoggableActionState) Number() protoreflect.EnumNumber
func (LoggingConfig_LoggableActionState) String ¶
func (x LoggingConfig_LoggableActionState) String() string
func (LoggingConfig_LoggableActionState) Type ¶
func (LoggingConfig_LoggableActionState) Type() protoreflect.EnumType
type Manifest ¶
type Manifest struct {
// Required. `manifest_location` must contain the manifest source file that is
// a CSV file in a Google Cloud Storage bucket. Each row in the file must
// include the object details i.e. BucketId and Name. Generation may
// optionally be specified. When it is not specified the live object is acted
// upon. `manifest_location` should either be 1) An absolute path to the
// object in the format of `gs://bucket_name/path/file_name.csv`. 2) An
// absolute path with a single wildcard character in the file name, for
// example `gs://bucket_name/path/file_name*.csv`.
// If manifest location is specified with a wildcard, objects in all manifest
// files matching the pattern will be acted upon.
ManifestLocation string `protobuf:"bytes,2,opt,name=manifest_location,json=manifestLocation,proto3" json:"manifest_location,omitempty"`
// contains filtered or unexported fields
}
Describes list of objects to be transformed.
func (*Manifest) Descriptor
deprecated
func (*Manifest) GetManifestLocation ¶
func (*Manifest) ProtoMessage ¶
func (*Manifest) ProtoMessage()
func (*Manifest) ProtoReflect ¶
func (x *Manifest) ProtoReflect() protoreflect.Message
type ObjectCustomContextPayload ¶ added in v0.4.0
type ObjectCustomContextPayload struct {
// The value of the object custom context.
// If set, `value` must NOT be an empty string since it is a required field in
// custom context. If unset, `value` will be ignored and no changes will be
// made to the `value` field of the custom context payload.
Value *string `protobuf:"bytes,1,opt,name=value,proto3,oneof" json:"value,omitempty"`
// contains filtered or unexported fields
}
Describes the payload of a user defined object custom context.
func (*ObjectCustomContextPayload) Descriptor
deprecated
added in
v0.4.0
func (*ObjectCustomContextPayload) Descriptor() ([]byte, []int)
Deprecated: Use ObjectCustomContextPayload.ProtoReflect.Descriptor instead.
func (*ObjectCustomContextPayload) GetValue ¶ added in v0.4.0
func (x *ObjectCustomContextPayload) GetValue() string
func (*ObjectCustomContextPayload) ProtoMessage ¶ added in v0.4.0
func (*ObjectCustomContextPayload) ProtoMessage()
func (*ObjectCustomContextPayload) ProtoReflect ¶ added in v0.4.0
func (x *ObjectCustomContextPayload) ProtoReflect() protoreflect.Message
func (*ObjectCustomContextPayload) Reset ¶ added in v0.4.0
func (x *ObjectCustomContextPayload) Reset()
func (*ObjectCustomContextPayload) String ¶ added in v0.4.0
func (x *ObjectCustomContextPayload) String() string
type ObjectRetention ¶ added in v0.2.0
type ObjectRetention struct {
// Required. The time when the object will be retained until. UNSET will clear
// the retention. Must be specified in RFC 3339 format e.g.
// YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.
RetainUntilTime *string `protobuf:"bytes,1,opt,name=retain_until_time,json=retainUntilTime,proto3,oneof" json:"retain_until_time,omitempty"`
// Required. The retention mode of the object.
RetentionMode *ObjectRetention_RetentionMode `` /* 181-byte string literal not displayed */
// contains filtered or unexported fields
}
Describes options for object retention update.
func (*ObjectRetention) Descriptor
deprecated
added in
v0.2.0
func (*ObjectRetention) Descriptor() ([]byte, []int)
Deprecated: Use ObjectRetention.ProtoReflect.Descriptor instead.
func (*ObjectRetention) GetRetainUntilTime ¶ added in v0.2.0
func (x *ObjectRetention) GetRetainUntilTime() string
func (*ObjectRetention) GetRetentionMode ¶ added in v0.2.0
func (x *ObjectRetention) GetRetentionMode() ObjectRetention_RetentionMode
func (*ObjectRetention) ProtoMessage ¶ added in v0.2.0
func (*ObjectRetention) ProtoMessage()
func (*ObjectRetention) ProtoReflect ¶ added in v0.2.0
func (x *ObjectRetention) ProtoReflect() protoreflect.Message
func (*ObjectRetention) Reset ¶ added in v0.2.0
func (x *ObjectRetention) Reset()
func (*ObjectRetention) String ¶ added in v0.2.0
func (x *ObjectRetention) String() string
type ObjectRetention_RetentionMode ¶ added in v0.2.0
type ObjectRetention_RetentionMode int32
Describes the retention mode.
const ( // If set and retain_until_time is empty, clears the retention. ObjectRetention_RETENTION_MODE_UNSPECIFIED ObjectRetention_RetentionMode = 0 // Sets the retention mode to locked. ObjectRetention_LOCKED ObjectRetention_RetentionMode = 1 // Sets the retention mode to unlocked. ObjectRetention_UNLOCKED ObjectRetention_RetentionMode = 2 )
func (ObjectRetention_RetentionMode) Descriptor ¶ added in v0.2.0
func (ObjectRetention_RetentionMode) Descriptor() protoreflect.EnumDescriptor
func (ObjectRetention_RetentionMode) Enum ¶ added in v0.2.0
func (x ObjectRetention_RetentionMode) Enum() *ObjectRetention_RetentionMode
func (ObjectRetention_RetentionMode) EnumDescriptor
deprecated
added in
v0.2.0
func (ObjectRetention_RetentionMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use ObjectRetention_RetentionMode.Descriptor instead.
func (ObjectRetention_RetentionMode) Number ¶ added in v0.2.0
func (x ObjectRetention_RetentionMode) Number() protoreflect.EnumNumber
func (ObjectRetention_RetentionMode) String ¶ added in v0.2.0
func (x ObjectRetention_RetentionMode) String() string
func (ObjectRetention_RetentionMode) Type ¶ added in v0.2.0
func (ObjectRetention_RetentionMode) Type() protoreflect.EnumType
type OperationMetadata ¶
type OperationMetadata struct {
// Output only. The unique operation resource name.
// Format: projects/{project}/locations/global/operations/{operation}.
Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have been cancelled successfully
// have
// [google.longrunning.Operation.error][google.longrunning.Operation.error]
// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to
// `[Code.CANCELLED][google.rpc.Code.CANCELLED]`.
RequestedCancellation bool `protobuf:"varint,7,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// Output only. API version used to start the operation.
ApiVersion string `protobuf:"bytes,8,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// Output only. The Job associated with the operation.
Job *Job `protobuf:"bytes,10,opt,name=job,proto3" json:"job,omitempty"`
// contains filtered or unexported fields
}
Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
deprecated
func (*OperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion ¶
func (x *OperationMetadata) GetApiVersion() string
func (*OperationMetadata) GetCreateTime ¶
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
func (*OperationMetadata) GetEndTime ¶
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
func (*OperationMetadata) GetJob ¶
func (x *OperationMetadata) GetJob() *Job
func (*OperationMetadata) GetOperation ¶
func (x *OperationMetadata) GetOperation() string
func (*OperationMetadata) GetRequestedCancellation ¶
func (x *OperationMetadata) GetRequestedCancellation() bool
func (*OperationMetadata) ProtoMessage ¶
func (*OperationMetadata) ProtoMessage()
func (*OperationMetadata) ProtoReflect ¶
func (x *OperationMetadata) ProtoReflect() protoreflect.Message
func (*OperationMetadata) Reset ¶
func (x *OperationMetadata) Reset()
func (*OperationMetadata) String ¶
func (x *OperationMetadata) String() string
type PrefixList ¶
type PrefixList struct {
// Optional. Include prefixes of the objects to be transformed.
// * Supports full object name
// * Supports prefix of the object name
// * Wildcards are not supported
// * Supports empty string for all objects in a bucket.
IncludedObjectPrefixes []string `` /* 129-byte string literal not displayed */
// contains filtered or unexported fields
}
Describes prefixes of objects to be transformed.
func (*PrefixList) Descriptor
deprecated
func (*PrefixList) Descriptor() ([]byte, []int)
Deprecated: Use PrefixList.ProtoReflect.Descriptor instead.
func (*PrefixList) GetIncludedObjectPrefixes ¶
func (x *PrefixList) GetIncludedObjectPrefixes() []string
func (*PrefixList) ProtoMessage ¶
func (*PrefixList) ProtoMessage()
func (*PrefixList) ProtoReflect ¶
func (x *PrefixList) ProtoReflect() protoreflect.Message
func (*PrefixList) Reset ¶
func (x *PrefixList) Reset()
func (*PrefixList) String ¶
func (x *PrefixList) String() string
type PutMetadata ¶
type PutMetadata struct {
// Optional. Updates objects Content-Disposition fixed metadata. Unset values
// will be ignored. Set empty values to clear the metadata. Refer
// https://cloud.google.com/storage/docs/metadata#content-disposition for
// additional documentation.
ContentDisposition *string `protobuf:"bytes,1,opt,name=content_disposition,json=contentDisposition,proto3,oneof" json:"content_disposition,omitempty"`
// Optional. Updates objects Content-Encoding fixed metadata. Unset values
// will be ignored. Set empty values to clear the metadata. Refer to
// documentation in
// https://cloud.google.com/storage/docs/metadata#content-encoding.
ContentEncoding *string `protobuf:"bytes,2,opt,name=content_encoding,json=contentEncoding,proto3,oneof" json:"content_encoding,omitempty"`
// Optional. Updates objects Content-Language fixed metadata. Refer to ISO
// 639-1 language codes for typical values of this metadata. Max length 100
// characters. Unset values will be ignored. Set empty values to clear the
// metadata. Refer to documentation in
// https://cloud.google.com/storage/docs/metadata#content-language.
ContentLanguage *string `protobuf:"bytes,3,opt,name=content_language,json=contentLanguage,proto3,oneof" json:"content_language,omitempty"`
// Optional. Updates objects Content-Type fixed metadata. Unset values will be
// ignored. Set empty values to clear the metadata. Refer to documentation in
// https://cloud.google.com/storage/docs/metadata#content-type
ContentType *string `protobuf:"bytes,4,opt,name=content_type,json=contentType,proto3,oneof" json:"content_type,omitempty"`
// Optional. Updates objects Cache-Control fixed metadata. Unset values will
// be ignored. Set empty values to clear the metadata. Additionally, the value
// for Custom-Time cannot decrease. Refer to documentation in
// https://cloud.google.com/storage/docs/metadata#caching_data.
CacheControl *string `protobuf:"bytes,5,opt,name=cache_control,json=cacheControl,proto3,oneof" json:"cache_control,omitempty"`
// Optional. Updates objects Custom-Time fixed metadata. Unset values will be
// ignored. Set empty values to clear the metadata. Refer to documentation in
// https://cloud.google.com/storage/docs/metadata#custom-time.
CustomTime *string `protobuf:"bytes,6,opt,name=custom_time,json=customTime,proto3,oneof" json:"custom_time,omitempty"`
// Optional. Updates objects custom metadata. Adds or sets individual custom
// metadata key value pairs on objects. Keys that are set with empty custom
// metadata values will have its value cleared. Existing custom metadata not
// specified with this flag is not changed. Refer to documentation in
// https://cloud.google.com/storage/docs/metadata#custom-metadata
CustomMetadata map[string]string `` /* 191-byte string literal not displayed */
// Optional. Updates objects retention lock configuration. Unset values will
// be ignored. Set empty values to clear the retention for the object with
// existing `Unlocked` retention mode. Object with existing `Locked` retention
// mode cannot be cleared or reduce retain_until_time. Refer to documentation
// in https://cloud.google.com/storage/docs/object-lock
ObjectRetention *ObjectRetention `protobuf:"bytes,8,opt,name=object_retention,json=objectRetention,proto3,oneof" json:"object_retention,omitempty"`
// contains filtered or unexported fields
}
Describes options for object metadata update.
func (*PutMetadata) Descriptor
deprecated
func (*PutMetadata) Descriptor() ([]byte, []int)
Deprecated: Use PutMetadata.ProtoReflect.Descriptor instead.
func (*PutMetadata) GetCacheControl ¶
func (x *PutMetadata) GetCacheControl() string
func (*PutMetadata) GetContentDisposition ¶
func (x *PutMetadata) GetContentDisposition() string
func (*PutMetadata) GetContentEncoding ¶
func (x *PutMetadata) GetContentEncoding() string
func (*PutMetadata) GetContentLanguage ¶
func (x *PutMetadata) GetContentLanguage() string
func (*PutMetadata) GetContentType ¶
func (x *PutMetadata) GetContentType() string
func (*PutMetadata) GetCustomMetadata ¶
func (x *PutMetadata) GetCustomMetadata() map[string]string
func (*PutMetadata) GetCustomTime ¶
func (x *PutMetadata) GetCustomTime() string
func (*PutMetadata) GetObjectRetention ¶ added in v0.2.0
func (x *PutMetadata) GetObjectRetention() *ObjectRetention
func (*PutMetadata) ProtoMessage ¶
func (*PutMetadata) ProtoMessage()
func (*PutMetadata) ProtoReflect ¶
func (x *PutMetadata) ProtoReflect() protoreflect.Message
func (*PutMetadata) Reset ¶
func (x *PutMetadata) Reset()
func (*PutMetadata) String ¶
func (x *PutMetadata) String() string
type PutObjectHold ¶
type PutObjectHold struct {
// Required. Updates object temporary holds state. When object temporary hold
// is set, object cannot be deleted or replaced.
TemporaryHold PutObjectHold_HoldStatus `` /* 170-byte string literal not displayed */
// Required. Updates object event based holds state. When object event based
// hold is set, object cannot be deleted or replaced. Resets object's time in
// the bucket for the purposes of the retention period.
EventBasedHold PutObjectHold_HoldStatus `` /* 175-byte string literal not displayed */
// contains filtered or unexported fields
}
Describes options to update object hold.
func (*PutObjectHold) Descriptor
deprecated
func (*PutObjectHold) Descriptor() ([]byte, []int)
Deprecated: Use PutObjectHold.ProtoReflect.Descriptor instead.
func (*PutObjectHold) GetEventBasedHold ¶
func (x *PutObjectHold) GetEventBasedHold() PutObjectHold_HoldStatus
func (*PutObjectHold) GetTemporaryHold ¶
func (x *PutObjectHold) GetTemporaryHold() PutObjectHold_HoldStatus
func (*PutObjectHold) ProtoMessage ¶
func (*PutObjectHold) ProtoMessage()
func (*PutObjectHold) ProtoReflect ¶
func (x *PutObjectHold) ProtoReflect() protoreflect.Message
func (*PutObjectHold) Reset ¶
func (x *PutObjectHold) Reset()
func (*PutObjectHold) String ¶
func (x *PutObjectHold) String() string
type PutObjectHold_HoldStatus ¶
type PutObjectHold_HoldStatus int32
Describes the status of the hold.
const ( // Default value, Object hold status will not be changed. PutObjectHold_HOLD_STATUS_UNSPECIFIED PutObjectHold_HoldStatus = 0 // Places the hold. PutObjectHold_SET PutObjectHold_HoldStatus = 1 // Releases the hold. PutObjectHold_UNSET PutObjectHold_HoldStatus = 2 )
func (PutObjectHold_HoldStatus) Descriptor ¶
func (PutObjectHold_HoldStatus) Descriptor() protoreflect.EnumDescriptor
func (PutObjectHold_HoldStatus) Enum ¶
func (x PutObjectHold_HoldStatus) Enum() *PutObjectHold_HoldStatus
func (PutObjectHold_HoldStatus) EnumDescriptor
deprecated
func (PutObjectHold_HoldStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use PutObjectHold_HoldStatus.Descriptor instead.
func (PutObjectHold_HoldStatus) Number ¶
func (x PutObjectHold_HoldStatus) Number() protoreflect.EnumNumber
func (PutObjectHold_HoldStatus) String ¶
func (x PutObjectHold_HoldStatus) String() string
func (PutObjectHold_HoldStatus) Type ¶
func (PutObjectHold_HoldStatus) Type() protoreflect.EnumType
type RewriteObject ¶
type RewriteObject struct {
// Required. Resource name of the Cloud KMS key that will be used to encrypt
// the object. The Cloud KMS key must be located in same location as the
// object. Refer to
// https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key
// for additional documentation. Format:
// projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}
// For example:
// "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key".
// The object will be rewritten and set with the specified KMS key.
KmsKey *string `protobuf:"bytes,1,opt,name=kms_key,json=kmsKey,proto3,oneof" json:"kms_key,omitempty"`
// contains filtered or unexported fields
}
Describes options for object rewrite.
func (*RewriteObject) Descriptor
deprecated
func (*RewriteObject) Descriptor() ([]byte, []int)
Deprecated: Use RewriteObject.ProtoReflect.Descriptor instead.
func (*RewriteObject) GetKmsKey ¶
func (x *RewriteObject) GetKmsKey() string
func (*RewriteObject) ProtoMessage ¶
func (*RewriteObject) ProtoMessage()
func (*RewriteObject) ProtoReflect ¶
func (x *RewriteObject) ProtoReflect() protoreflect.Message
func (*RewriteObject) Reset ¶
func (x *RewriteObject) Reset()
func (*RewriteObject) String ¶
func (x *RewriteObject) String() string
type StorageBatchOperationsClient ¶
type StorageBatchOperationsClient interface {
// Lists Jobs in a given project.
ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error)
// Gets a batch job.
GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error)
// Creates a batch job.
CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a batch job.
DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Cancels a batch job.
CancelJob(ctx context.Context, in *CancelJobRequest, opts ...grpc.CallOption) (*CancelJobResponse, error)
// Lists BucketOperations in a given project and job.
ListBucketOperations(ctx context.Context, in *ListBucketOperationsRequest, opts ...grpc.CallOption) (*ListBucketOperationsResponse, error)
// Gets a BucketOperation.
GetBucketOperation(ctx context.Context, in *GetBucketOperationRequest, opts ...grpc.CallOption) (*BucketOperation, error)
}
StorageBatchOperationsClient is the client API for StorageBatchOperations 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 NewStorageBatchOperationsClient ¶
func NewStorageBatchOperationsClient(cc grpc.ClientConnInterface) StorageBatchOperationsClient
type StorageBatchOperationsServer ¶
type StorageBatchOperationsServer interface {
// Lists Jobs in a given project.
ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
// Gets a batch job.
GetJob(context.Context, *GetJobRequest) (*Job, error)
// Creates a batch job.
CreateJob(context.Context, *CreateJobRequest) (*longrunningpb.Operation, error)
// Deletes a batch job.
DeleteJob(context.Context, *DeleteJobRequest) (*emptypb.Empty, error)
// Cancels a batch job.
CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)
// Lists BucketOperations in a given project and job.
ListBucketOperations(context.Context, *ListBucketOperationsRequest) (*ListBucketOperationsResponse, error)
// Gets a BucketOperation.
GetBucketOperation(context.Context, *GetBucketOperationRequest) (*BucketOperation, error)
}
StorageBatchOperationsServer is the server API for StorageBatchOperations service. All implementations should embed UnimplementedStorageBatchOperationsServer for forward compatibility
type UnimplementedStorageBatchOperationsServer ¶
type UnimplementedStorageBatchOperationsServer struct {
}
UnimplementedStorageBatchOperationsServer should be embedded to have forward compatible implementations.
func (UnimplementedStorageBatchOperationsServer) CancelJob ¶
func (UnimplementedStorageBatchOperationsServer) CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)
func (UnimplementedStorageBatchOperationsServer) CreateJob ¶
func (UnimplementedStorageBatchOperationsServer) CreateJob(context.Context, *CreateJobRequest) (*longrunningpb.Operation, error)
func (UnimplementedStorageBatchOperationsServer) DeleteJob ¶
func (UnimplementedStorageBatchOperationsServer) DeleteJob(context.Context, *DeleteJobRequest) (*emptypb.Empty, error)
func (UnimplementedStorageBatchOperationsServer) GetBucketOperation ¶ added in v0.3.0
func (UnimplementedStorageBatchOperationsServer) GetBucketOperation(context.Context, *GetBucketOperationRequest) (*BucketOperation, error)
func (UnimplementedStorageBatchOperationsServer) GetJob ¶
func (UnimplementedStorageBatchOperationsServer) GetJob(context.Context, *GetJobRequest) (*Job, error)
func (UnimplementedStorageBatchOperationsServer) ListBucketOperations ¶ added in v0.3.0
func (UnimplementedStorageBatchOperationsServer) ListBucketOperations(context.Context, *ListBucketOperationsRequest) (*ListBucketOperationsResponse, error)
func (UnimplementedStorageBatchOperationsServer) ListJobs ¶
func (UnimplementedStorageBatchOperationsServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
type UnsafeStorageBatchOperationsServer ¶ added in v0.1.1
type UnsafeStorageBatchOperationsServer interface {
// contains filtered or unexported methods
}
UnsafeStorageBatchOperationsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StorageBatchOperationsServer will result in compilation errors.
type UpdateObjectCustomContext ¶ added in v0.4.0
type UpdateObjectCustomContext struct {
// One of the actions must be set.
//
// Types that are assignable to Action:
//
// *UpdateObjectCustomContext_CustomContextUpdates
// *UpdateObjectCustomContext_ClearAll
Action isUpdateObjectCustomContext_Action `protobuf_oneof:"action"`
// contains filtered or unexported fields
}
Describes options to update object custom contexts.
func (*UpdateObjectCustomContext) Descriptor
deprecated
added in
v0.4.0
func (*UpdateObjectCustomContext) Descriptor() ([]byte, []int)
Deprecated: Use UpdateObjectCustomContext.ProtoReflect.Descriptor instead.
func (*UpdateObjectCustomContext) GetAction ¶ added in v0.4.0
func (m *UpdateObjectCustomContext) GetAction() isUpdateObjectCustomContext_Action
func (*UpdateObjectCustomContext) GetClearAll ¶ added in v0.4.0
func (x *UpdateObjectCustomContext) GetClearAll() bool
func (*UpdateObjectCustomContext) GetCustomContextUpdates ¶ added in v0.4.0
func (x *UpdateObjectCustomContext) GetCustomContextUpdates() *CustomContextUpdates
func (*UpdateObjectCustomContext) ProtoMessage ¶ added in v0.4.0
func (*UpdateObjectCustomContext) ProtoMessage()
func (*UpdateObjectCustomContext) ProtoReflect ¶ added in v0.4.0
func (x *UpdateObjectCustomContext) ProtoReflect() protoreflect.Message
func (*UpdateObjectCustomContext) Reset ¶ added in v0.4.0
func (x *UpdateObjectCustomContext) Reset()
func (*UpdateObjectCustomContext) String ¶ added in v0.4.0
func (x *UpdateObjectCustomContext) String() string
type UpdateObjectCustomContext_ClearAll ¶ added in v0.4.0
type UpdateObjectCustomContext_ClearAll struct {
// If set, must be set to true and all existing object custom contexts will
// be deleted.
ClearAll bool `protobuf:"varint,2,opt,name=clear_all,json=clearAll,proto3,oneof"`
}
type UpdateObjectCustomContext_CustomContextUpdates ¶ added in v0.4.0
type UpdateObjectCustomContext_CustomContextUpdates struct {
// A collection of updates to apply to specific custom contexts.
// Use this to add, update or delete individual contexts by key.
CustomContextUpdates *CustomContextUpdates `protobuf:"bytes,1,opt,name=custom_context_updates,json=customContextUpdates,proto3,oneof"`
}