var File_google_storage_control_v2_storage_control_proto protoreflect.FileDescriptor
func RegisterStorageControlServer(s *grpc.Server, srv StorageControlServer)
The message contains metadata that is common to all Storage Control long-running operations, present in its `google.longrunning.Operation` messages, and accessible via `metadata.common_metadata`.
type CommonLongRunningOperationMetadata struct {
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. The time the operation was last modified.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The type of operation invoked.
Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
// Output only. Identifies whether the user has requested cancellation.
RequestedCancellation bool `protobuf:"varint,5,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// Output only. The estimated progress of the operation in percentage [0,
// 100]. The value -1 means the progress is unknown.
ProgressPercent int32 `protobuf:"varint,6,opt,name=progress_percent,json=progressPercent,proto3" json:"progress_percent,omitempty"`
// contains filtered or unexported fields
}
func (*CommonLongRunningOperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CommonLongRunningOperationMetadata.ProtoReflect.Descriptor instead.
func (x *CommonLongRunningOperationMetadata) GetCreateTime() *timestamppb.Timestamp
func (x *CommonLongRunningOperationMetadata) GetEndTime() *timestamppb.Timestamp
func (x *CommonLongRunningOperationMetadata) GetProgressPercent() int32
func (x *CommonLongRunningOperationMetadata) GetRequestedCancellation() bool
func (x *CommonLongRunningOperationMetadata) GetType() string
func (x *CommonLongRunningOperationMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*CommonLongRunningOperationMetadata) ProtoMessage()
func (x *CommonLongRunningOperationMetadata) ProtoReflect() protoreflect.Message
func (x *CommonLongRunningOperationMetadata) Reset()
func (x *CommonLongRunningOperationMetadata) String() string
Request message for CreateFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type CreateFolderRequest struct {
// Required. Name of the bucket in which the folder will reside. The bucket
// must be a hierarchical namespace enabled bucket.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Properties of the new folder being created.
// The bucket and name of the folder are specified in the parent and folder_id
// fields, respectively. Populating those fields in `folder` will result in an
// error.
Folder *Folder `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,omitempty"`
// Required. The full name of a folder, including all its parent folders.
// Folders use single '/' characters as a delimiter.
// The folder_id must end with a slash.
// For example, the folder_id of "books/biographies/" would create a new
// "biographies/" folder under the "books/" folder.
FolderId string `protobuf:"bytes,3,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
// Optional. If true, parent folder doesn't have to be present and all missing
// ancestor folders will be created atomically.
Recursive bool `protobuf:"varint,4,opt,name=recursive,proto3" json:"recursive,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*CreateFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFolderRequest.ProtoReflect.Descriptor instead.
func (x *CreateFolderRequest) GetFolder() *Folder
func (x *CreateFolderRequest) GetFolderId() string
func (x *CreateFolderRequest) GetParent() string
func (x *CreateFolderRequest) GetRecursive() bool
func (x *CreateFolderRequest) GetRequestId() string
func (*CreateFolderRequest) ProtoMessage()
func (x *CreateFolderRequest) ProtoReflect() protoreflect.Message
func (x *CreateFolderRequest) Reset()
func (x *CreateFolderRequest) String() string
Request message for CreateManagedFolder.
type CreateManagedFolderRequest struct {
// Required. Name of the bucket this managed folder belongs to.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Properties of the managed folder being created.
// The bucket and managed folder names are specified in the `parent` and
// `managed_folder_id` fields. Populating these fields in `managed_folder`
// will result in an error.
ManagedFolder *ManagedFolder `protobuf:"bytes,2,opt,name=managed_folder,json=managedFolder,proto3" json:"managed_folder,omitempty"`
// Required. The name of the managed folder. It uses a single `/` as delimiter
// and leading and trailing `/` are allowed.
ManagedFolderId string `protobuf:"bytes,3,opt,name=managed_folder_id,json=managedFolderId,proto3" json:"managed_folder_id,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*CreateManagedFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateManagedFolderRequest.ProtoReflect.Descriptor instead.
func (x *CreateManagedFolderRequest) GetManagedFolder() *ManagedFolder
func (x *CreateManagedFolderRequest) GetManagedFolderId() string
func (x *CreateManagedFolderRequest) GetParent() string
func (x *CreateManagedFolderRequest) GetRequestId() string
func (*CreateManagedFolderRequest) ProtoMessage()
func (x *CreateManagedFolderRequest) ProtoReflect() protoreflect.Message
func (x *CreateManagedFolderRequest) Reset()
func (x *CreateManagedFolderRequest) String() string
Request message for DeleteFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type DeleteFolderRequest struct {
// Required. Name of the folder.
// Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// Makes the operation only succeed conditional on whether the folder's
// current metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation only succeed conditional on whether the folder's
// current metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderRequest.ProtoReflect.Descriptor instead.
func (x *DeleteFolderRequest) GetIfMetagenerationMatch() int64
func (x *DeleteFolderRequest) GetIfMetagenerationNotMatch() int64
func (x *DeleteFolderRequest) GetName() string
func (x *DeleteFolderRequest) GetRequestId() string
func (*DeleteFolderRequest) ProtoMessage()
func (x *DeleteFolderRequest) ProtoReflect() protoreflect.Message
func (x *DeleteFolderRequest) Reset()
func (x *DeleteFolderRequest) String() string
DeleteManagedFolder RPC request message.
type DeleteManagedFolderRequest struct {
// Required. Name of the managed folder.
// Format:
// `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
// The operation succeeds conditional on the managed folder's current
// metageneration matching the value here specified.
IfMetagenerationMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// The operation succeeds conditional on the managed folder's current
// metageneration NOT matching the value here specified.
IfMetagenerationNotMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Allows deletion of a managed folder even if it is not empty.
// A managed folder is empty if it manages no child managed folders or
// objects. Caller must have permission for
// storage.managedFolders.setIamPolicy.
AllowNonEmpty bool `protobuf:"varint,5,opt,name=allow_non_empty,json=allowNonEmpty,proto3" json:"allow_non_empty,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,6,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteManagedFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteManagedFolderRequest.ProtoReflect.Descriptor instead.
func (x *DeleteManagedFolderRequest) GetAllowNonEmpty() bool
func (x *DeleteManagedFolderRequest) GetIfMetagenerationMatch() int64
func (x *DeleteManagedFolderRequest) GetIfMetagenerationNotMatch() int64
func (x *DeleteManagedFolderRequest) GetName() string
func (x *DeleteManagedFolderRequest) GetRequestId() string
func (*DeleteManagedFolderRequest) ProtoMessage()
func (x *DeleteManagedFolderRequest) ProtoReflect() protoreflect.Message
func (x *DeleteManagedFolderRequest) Reset()
func (x *DeleteManagedFolderRequest) String() string
A folder resource. This resource can only exist in a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type Folder struct {
// Identifier. The name of this folder.
// Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The version of the metadata for this folder. Used for
// preconditions and for detecting changes in metadata.
Metageneration int64 `protobuf:"varint,3,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// Output only. The creation time of the folder.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The modification time of the folder.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Only present if the folder is part of an ongoing RenameFolder
// operation. Contains information which can be used to query the operation
// status. The presence of this field also indicates all write operations are
// blocked for this folder, including folder, managed folder, and object
// operations.
PendingRenameInfo *PendingRenameInfo `protobuf:"bytes,7,opt,name=pending_rename_info,json=pendingRenameInfo,proto3" json:"pending_rename_info,omitempty"`
// contains filtered or unexported fields
}
func (*Folder) Descriptor() ([]byte, []int)
Deprecated: Use Folder.ProtoReflect.Descriptor instead.
func (x *Folder) GetCreateTime() *timestamppb.Timestamp
func (x *Folder) GetMetageneration() int64
func (x *Folder) GetName() string
func (x *Folder) GetPendingRenameInfo() *PendingRenameInfo
func (x *Folder) GetUpdateTime() *timestamppb.Timestamp
func (*Folder) ProtoMessage()
func (x *Folder) ProtoReflect() protoreflect.Message
func (x *Folder) Reset()
func (x *Folder) String() string
Request message for GetFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type GetFolderRequest struct {
// Required. Name of the folder.
// Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// Makes the operation only succeed conditional on whether the folder's
// current metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation only succeed conditional on whether the folder's
// current metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*GetFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFolderRequest.ProtoReflect.Descriptor instead.
func (x *GetFolderRequest) GetIfMetagenerationMatch() int64
func (x *GetFolderRequest) GetIfMetagenerationNotMatch() int64
func (x *GetFolderRequest) GetName() string
func (x *GetFolderRequest) GetRequestId() string
func (*GetFolderRequest) ProtoMessage()
func (x *GetFolderRequest) ProtoReflect() protoreflect.Message
func (x *GetFolderRequest) Reset()
func (x *GetFolderRequest) String() string
Request message for GetManagedFolder.
type GetManagedFolderRequest struct {
// Required. Name of the managed folder.
// Format:
// `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// The operation succeeds conditional on the managed folder's current
// metageneration matching the value here specified.
IfMetagenerationMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// The operation succeeds conditional on the managed folder's current
// metageneration NOT matching the value here specified.
IfMetagenerationNotMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*GetManagedFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetManagedFolderRequest.ProtoReflect.Descriptor instead.
func (x *GetManagedFolderRequest) GetIfMetagenerationMatch() int64
func (x *GetManagedFolderRequest) GetIfMetagenerationNotMatch() int64
func (x *GetManagedFolderRequest) GetName() string
func (x *GetManagedFolderRequest) GetRequestId() string
func (*GetManagedFolderRequest) ProtoMessage()
func (x *GetManagedFolderRequest) ProtoReflect() protoreflect.Message
func (x *GetManagedFolderRequest) Reset()
func (x *GetManagedFolderRequest) String() string
Request message for GetStorageLayout.
type GetStorageLayoutRequest struct {
// Required. The name of the StorageLayout resource.
// Format: `projects/{project}/buckets/{bucket}/storageLayout`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// An optional prefix used for permission check. It is useful when the caller
// only has limited permissions under a specific prefix.
Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*GetStorageLayoutRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetStorageLayoutRequest.ProtoReflect.Descriptor instead.
func (x *GetStorageLayoutRequest) GetName() string
func (x *GetStorageLayoutRequest) GetPrefix() string
func (x *GetStorageLayoutRequest) GetRequestId() string
func (*GetStorageLayoutRequest) ProtoMessage()
func (x *GetStorageLayoutRequest) ProtoReflect() protoreflect.Message
func (x *GetStorageLayoutRequest) Reset()
func (x *GetStorageLayoutRequest) String() string
Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type ListFoldersRequest struct {
// Required. Name of the bucket in which to look for folders. The bucket must
// be a hierarchical namespace enabled bucket.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of folders to return in a single response. The
// service will use 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. Filter results to folders whose names begin with this prefix.
// If set, the value must either be an empty string or end with a '/'.
Prefix string `protobuf:"bytes,4,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Optional. If set, returns results in a directory-like mode. The results
// will only include folders that either exactly match the above prefix, or
// are one level below the prefix. The only supported value is '/'.
Delimiter string `protobuf:"bytes,8,opt,name=delimiter,proto3" json:"delimiter,omitempty"`
// Optional. Filter results to folders whose names are lexicographically equal
// to or after lexicographic_start. If lexicographic_end is also set, the
// folders listed have names between lexicographic_start (inclusive) and
// lexicographic_end (exclusive).
LexicographicStart string `protobuf:"bytes,6,opt,name=lexicographic_start,json=lexicographicStart,proto3" json:"lexicographic_start,omitempty"`
// Optional. Filter results to folders whose names are lexicographically
// before lexicographic_end. If lexicographic_start is also set, the folders
// listed have names between lexicographic_start (inclusive) and
// lexicographic_end (exclusive).
LexicographicEnd string `protobuf:"bytes,7,opt,name=lexicographic_end,json=lexicographicEnd,proto3" json:"lexicographic_end,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,9,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*ListFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersRequest.ProtoReflect.Descriptor instead.
func (x *ListFoldersRequest) GetDelimiter() string
func (x *ListFoldersRequest) GetLexicographicEnd() string
func (x *ListFoldersRequest) GetLexicographicStart() string
func (x *ListFoldersRequest) GetPageSize() int32
func (x *ListFoldersRequest) GetPageToken() string
func (x *ListFoldersRequest) GetParent() string
func (x *ListFoldersRequest) GetPrefix() string
func (x *ListFoldersRequest) GetRequestId() string
func (*ListFoldersRequest) ProtoMessage()
func (x *ListFoldersRequest) ProtoReflect() protoreflect.Message
func (x *ListFoldersRequest) Reset()
func (x *ListFoldersRequest) String() string
Response message for ListFolders.
type ListFoldersResponse struct {
// The list of child folders
Folders []*Folder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,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"`
// contains filtered or unexported fields
}
func (*ListFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersResponse.ProtoReflect.Descriptor instead.
func (x *ListFoldersResponse) GetFolders() []*Folder
func (x *ListFoldersResponse) GetNextPageToken() string
func (*ListFoldersResponse) ProtoMessage()
func (x *ListFoldersResponse) ProtoReflect() protoreflect.Message
func (x *ListFoldersResponse) Reset()
func (x *ListFoldersResponse) String() string
Request message for ListManagedFolders.
type ListManagedFoldersRequest struct {
// Required. Name of the bucket this managed folder belongs to.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of managed folders to return in a single response.
// The service will use 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. Filter results to match managed folders with name starting with
// this prefix.
Prefix string `protobuf:"bytes,4,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted.
RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*ListManagedFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListManagedFoldersRequest.ProtoReflect.Descriptor instead.
func (x *ListManagedFoldersRequest) GetPageSize() int32
func (x *ListManagedFoldersRequest) GetPageToken() string
func (x *ListManagedFoldersRequest) GetParent() string
func (x *ListManagedFoldersRequest) GetPrefix() string
func (x *ListManagedFoldersRequest) GetRequestId() string
func (*ListManagedFoldersRequest) ProtoMessage()
func (x *ListManagedFoldersRequest) ProtoReflect() protoreflect.Message
func (x *ListManagedFoldersRequest) Reset()
func (x *ListManagedFoldersRequest) String() string
Response message for ListManagedFolders.
type ListManagedFoldersResponse struct {
// The list of matching managed folders
ManagedFolders []*ManagedFolder `protobuf:"bytes,1,rep,name=managed_folders,json=managedFolders,proto3" json:"managed_folders,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"`
// contains filtered or unexported fields
}
func (*ListManagedFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListManagedFoldersResponse.ProtoReflect.Descriptor instead.
func (x *ListManagedFoldersResponse) GetManagedFolders() []*ManagedFolder
func (x *ListManagedFoldersResponse) GetNextPageToken() string
func (*ListManagedFoldersResponse) ProtoMessage()
func (x *ListManagedFoldersResponse) ProtoReflect() protoreflect.Message
func (x *ListManagedFoldersResponse) Reset()
func (x *ListManagedFoldersResponse) String() string
A managed folder.
type ManagedFolder struct {
// Identifier. The name of this managed folder.
// Format:
// `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The metadata version of this managed folder. It increases
// whenever the metadata is updated. Used for preconditions and for detecting
// changes in metadata. Managed folders don't have a generation number.
Metageneration int64 `protobuf:"varint,3,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// Output only. The creation time of the managed folder.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The modification time of the managed folder.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
func (*ManagedFolder) Descriptor() ([]byte, []int)
Deprecated: Use ManagedFolder.ProtoReflect.Descriptor instead.
func (x *ManagedFolder) GetCreateTime() *timestamppb.Timestamp
func (x *ManagedFolder) GetMetageneration() int64
func (x *ManagedFolder) GetName() string
func (x *ManagedFolder) GetUpdateTime() *timestamppb.Timestamp
func (*ManagedFolder) ProtoMessage()
func (x *ManagedFolder) ProtoReflect() protoreflect.Message
func (x *ManagedFolder) Reset()
func (x *ManagedFolder) String() string
Contains information about a pending rename operation.
type PendingRenameInfo struct {
// Output only. The name of the rename operation.
Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
// contains filtered or unexported fields
}
func (*PendingRenameInfo) Descriptor() ([]byte, []int)
Deprecated: Use PendingRenameInfo.ProtoReflect.Descriptor instead.
func (x *PendingRenameInfo) GetOperation() string
func (*PendingRenameInfo) ProtoMessage()
func (x *PendingRenameInfo) ProtoReflect() protoreflect.Message
func (x *PendingRenameInfo) Reset()
func (x *PendingRenameInfo) String() string
Message returned in the metadata field of the Operation resource for RenameFolder operations.
type RenameFolderMetadata struct {
// Generic metadata for the long running operation.
CommonMetadata *CommonLongRunningOperationMetadata `protobuf:"bytes,1,opt,name=common_metadata,json=commonMetadata,proto3" json:"common_metadata,omitempty"`
// The path of the source folder.
SourceFolderId string `protobuf:"bytes,2,opt,name=source_folder_id,json=sourceFolderId,proto3" json:"source_folder_id,omitempty"`
// The path of the destination folder.
DestinationFolderId string `protobuf:"bytes,3,opt,name=destination_folder_id,json=destinationFolderId,proto3" json:"destination_folder_id,omitempty"`
// contains filtered or unexported fields
}
func (*RenameFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RenameFolderMetadata.ProtoReflect.Descriptor instead.
func (x *RenameFolderMetadata) GetCommonMetadata() *CommonLongRunningOperationMetadata
func (x *RenameFolderMetadata) GetDestinationFolderId() string
func (x *RenameFolderMetadata) GetSourceFolderId() string
func (*RenameFolderMetadata) ProtoMessage()
func (x *RenameFolderMetadata) ProtoReflect() protoreflect.Message
func (x *RenameFolderMetadata) Reset()
func (x *RenameFolderMetadata) String() string
Request message for RenameFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
type RenameFolderRequest struct {
// Required. Name of the source folder being renamed.
// Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
// Required. The destination folder ID, e.g. `foo/bar/`.
DestinationFolderId string `protobuf:"bytes,8,opt,name=destination_folder_id,json=destinationFolderId,proto3" json:"destination_folder_id,omitempty"`
// Makes the operation only succeed conditional on whether the source
// folder's current metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation only succeed conditional on whether the source
// folder's current metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,5,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Optional. A unique identifier for this request. UUID is the recommended
// format, but other formats are still accepted. This request is only
// idempotent if a `request_id` is provided.
RequestId string `protobuf:"bytes,6,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*RenameFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use RenameFolderRequest.ProtoReflect.Descriptor instead.
func (x *RenameFolderRequest) GetDestinationFolderId() string
func (x *RenameFolderRequest) GetIfMetagenerationMatch() int64
func (x *RenameFolderRequest) GetIfMetagenerationNotMatch() int64
func (x *RenameFolderRequest) GetName() string
func (x *RenameFolderRequest) GetRequestId() string
func (*RenameFolderRequest) ProtoMessage()
func (x *RenameFolderRequest) ProtoReflect() protoreflect.Message
func (x *RenameFolderRequest) Reset()
func (x *RenameFolderRequest) String() string
StorageControlClient is the client API for StorageControl service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type StorageControlClient interface {
// Creates a new folder. This operation is only applicable to a hierarchical
// namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
CreateFolder(ctx context.Context, in *CreateFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Permanently deletes an empty folder. This operation is only applicable to a
// hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
DeleteFolder(ctx context.Context, in *DeleteFolderRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns metadata for the specified folder. This operation is only
// applicable to a hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
GetFolder(ctx context.Context, in *GetFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Retrieves a list of folders. This operation is only applicable to a
// hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
ListFolders(ctx context.Context, in *ListFoldersRequest, opts ...grpc.CallOption) (*ListFoldersResponse, error)
// Renames a source folder to a destination folder. This operation is only
// applicable to a hierarchical namespace enabled bucket. During a rename, the
// source and destination folders are locked until the long running operation
// completes.
// Hierarchical namespace buckets are in allowlist preview.
RenameFolder(ctx context.Context, in *RenameFolderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Returns the storage layout configuration for a given bucket.
GetStorageLayout(ctx context.Context, in *GetStorageLayoutRequest, opts ...grpc.CallOption) (*StorageLayout, error)
// Creates a new managed folder.
CreateManagedFolder(ctx context.Context, in *CreateManagedFolderRequest, opts ...grpc.CallOption) (*ManagedFolder, error)
// Permanently deletes an empty managed folder.
DeleteManagedFolder(ctx context.Context, in *DeleteManagedFolderRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns metadata for the specified managed folder.
GetManagedFolder(ctx context.Context, in *GetManagedFolderRequest, opts ...grpc.CallOption) (*ManagedFolder, error)
// Retrieves a list of managed folders for a given bucket.
ListManagedFolders(ctx context.Context, in *ListManagedFoldersRequest, opts ...grpc.CallOption) (*ListManagedFoldersResponse, error)
}
func NewStorageControlClient(cc grpc.ClientConnInterface) StorageControlClient
StorageControlServer is the server API for StorageControl service.
type StorageControlServer interface {
// Creates a new folder. This operation is only applicable to a hierarchical
// namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
CreateFolder(context.Context, *CreateFolderRequest) (*Folder, error)
// Permanently deletes an empty folder. This operation is only applicable to a
// hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
DeleteFolder(context.Context, *DeleteFolderRequest) (*emptypb.Empty, error)
// Returns metadata for the specified folder. This operation is only
// applicable to a hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
GetFolder(context.Context, *GetFolderRequest) (*Folder, error)
// Retrieves a list of folders. This operation is only applicable to a
// hierarchical namespace enabled bucket.
// Hierarchical namespace buckets are in allowlist preview.
ListFolders(context.Context, *ListFoldersRequest) (*ListFoldersResponse, error)
// Renames a source folder to a destination folder. This operation is only
// applicable to a hierarchical namespace enabled bucket. During a rename, the
// source and destination folders are locked until the long running operation
// completes.
// Hierarchical namespace buckets are in allowlist preview.
RenameFolder(context.Context, *RenameFolderRequest) (*longrunningpb.Operation, error)
// Returns the storage layout configuration for a given bucket.
GetStorageLayout(context.Context, *GetStorageLayoutRequest) (*StorageLayout, error)
// Creates a new managed folder.
CreateManagedFolder(context.Context, *CreateManagedFolderRequest) (*ManagedFolder, error)
// Permanently deletes an empty managed folder.
DeleteManagedFolder(context.Context, *DeleteManagedFolderRequest) (*emptypb.Empty, error)
// Returns metadata for the specified managed folder.
GetManagedFolder(context.Context, *GetManagedFolderRequest) (*ManagedFolder, error)
// Retrieves a list of managed folders for a given bucket.
ListManagedFolders(context.Context, *ListManagedFoldersRequest) (*ListManagedFoldersResponse, error)
}
The storage layout configuration of a bucket.
type StorageLayout struct {
// Output only. The name of the StorageLayout resource.
// Format: `projects/{project}/buckets/{bucket}/storageLayout`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The location of the bucket.
Location string `protobuf:"bytes,2,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,3,opt,name=location_type,json=locationType,proto3" json:"location_type,omitempty"`
// Output only. The data placement configuration for custom dual region. If
// there is no configuration, this is not a custom dual region bucket.
CustomPlacementConfig *StorageLayout_CustomPlacementConfig `protobuf:"bytes,4,opt,name=custom_placement_config,json=customPlacementConfig,proto3" json:"custom_placement_config,omitempty"`
// Output only. The bucket's hierarchical namespace configuration. If there is
// no configuration, the hierarchical namespace is disabled.
HierarchicalNamespace *StorageLayout_HierarchicalNamespace `protobuf:"bytes,5,opt,name=hierarchical_namespace,json=hierarchicalNamespace,proto3" json:"hierarchical_namespace,omitempty"`
// contains filtered or unexported fields
}
func (*StorageLayout) Descriptor() ([]byte, []int)
Deprecated: Use StorageLayout.ProtoReflect.Descriptor instead.
func (x *StorageLayout) GetCustomPlacementConfig() *StorageLayout_CustomPlacementConfig
func (x *StorageLayout) GetHierarchicalNamespace() *StorageLayout_HierarchicalNamespace
func (x *StorageLayout) GetLocation() string
func (x *StorageLayout) GetLocationType() string
func (x *StorageLayout) GetName() string
func (*StorageLayout) ProtoMessage()
func (x *StorageLayout) ProtoReflect() protoreflect.Message
func (x *StorageLayout) Reset()
func (x *StorageLayout) String() string
Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion. More information on regions may be found [https://cloud.google.com/storage/docs/locations][here].
type StorageLayout_CustomPlacementConfig struct {
// 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
}
func (*StorageLayout_CustomPlacementConfig) Descriptor() ([]byte, []int)
Deprecated: Use StorageLayout_CustomPlacementConfig.ProtoReflect.Descriptor instead.
func (x *StorageLayout_CustomPlacementConfig) GetDataLocations() []string
func (*StorageLayout_CustomPlacementConfig) ProtoMessage()
func (x *StorageLayout_CustomPlacementConfig) ProtoReflect() protoreflect.Message
func (x *StorageLayout_CustomPlacementConfig) Reset()
func (x *StorageLayout_CustomPlacementConfig) String() string
Configuration for a bucket's hierarchical namespace feature.
type StorageLayout_HierarchicalNamespace struct {
// Enables the hierarchical namespace feature.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// contains filtered or unexported fields
}
func (*StorageLayout_HierarchicalNamespace) Descriptor() ([]byte, []int)
Deprecated: Use StorageLayout_HierarchicalNamespace.ProtoReflect.Descriptor instead.
func (x *StorageLayout_HierarchicalNamespace) GetEnabled() bool
func (*StorageLayout_HierarchicalNamespace) ProtoMessage()
func (x *StorageLayout_HierarchicalNamespace) ProtoReflect() protoreflect.Message
func (x *StorageLayout_HierarchicalNamespace) Reset()
func (x *StorageLayout_HierarchicalNamespace) String() string
UnimplementedStorageControlServer can be embedded to have forward compatible implementations.
type UnimplementedStorageControlServer struct {
}
func (*UnimplementedStorageControlServer) CreateFolder(context.Context, *CreateFolderRequest) (*Folder, error)
func (*UnimplementedStorageControlServer) CreateManagedFolder(context.Context, *CreateManagedFolderRequest) (*ManagedFolder, error)
func (*UnimplementedStorageControlServer) DeleteFolder(context.Context, *DeleteFolderRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageControlServer) DeleteManagedFolder(context.Context, *DeleteManagedFolderRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageControlServer) GetFolder(context.Context, *GetFolderRequest) (*Folder, error)
func (*UnimplementedStorageControlServer) GetManagedFolder(context.Context, *GetManagedFolderRequest) (*ManagedFolder, error)
func (*UnimplementedStorageControlServer) GetStorageLayout(context.Context, *GetStorageLayoutRequest) (*StorageLayout, error)
func (*UnimplementedStorageControlServer) ListFolders(context.Context, *ListFoldersRequest) (*ListFoldersResponse, error)
func (*UnimplementedStorageControlServer) ListManagedFolders(context.Context, *ListManagedFoldersRequest) (*ListManagedFoldersResponse, error)
func (*UnimplementedStorageControlServer) RenameFolder(context.Context, *RenameFolderRequest) (*longrunningpb.Operation, error)