controlpb

package
v1.41.0 Latest Latest
Warning

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

Go to latest
Published: May 13, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_google_storage_control_v2_storage_control_proto protoreflect.FileDescriptor

Functions

func RegisterStorageControlServer

func RegisterStorageControlServer(s *grpc.Server, srv StorageControlServer)

Types

type CommonLongRunningOperationMetadata

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
}

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`.

func (*CommonLongRunningOperationMetadata) Descriptor deprecated

func (*CommonLongRunningOperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CommonLongRunningOperationMetadata.ProtoReflect.Descriptor instead.

func (*CommonLongRunningOperationMetadata) GetCreateTime

func (*CommonLongRunningOperationMetadata) GetEndTime

func (*CommonLongRunningOperationMetadata) GetProgressPercent

func (x *CommonLongRunningOperationMetadata) GetProgressPercent() int32

func (*CommonLongRunningOperationMetadata) GetRequestedCancellation

func (x *CommonLongRunningOperationMetadata) GetRequestedCancellation() bool

func (*CommonLongRunningOperationMetadata) GetType

func (*CommonLongRunningOperationMetadata) GetUpdateTime

func (*CommonLongRunningOperationMetadata) ProtoMessage

func (*CommonLongRunningOperationMetadata) ProtoMessage()

func (*CommonLongRunningOperationMetadata) ProtoReflect

func (*CommonLongRunningOperationMetadata) Reset

func (*CommonLongRunningOperationMetadata) String

type CreateFolderRequest

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
}

Request message for CreateFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*CreateFolderRequest) Descriptor deprecated

func (*CreateFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFolderRequest.ProtoReflect.Descriptor instead.

func (*CreateFolderRequest) GetFolder

func (x *CreateFolderRequest) GetFolder() *Folder

func (*CreateFolderRequest) GetFolderId

func (x *CreateFolderRequest) GetFolderId() string

func (*CreateFolderRequest) GetParent

func (x *CreateFolderRequest) GetParent() string

func (*CreateFolderRequest) GetRecursive

func (x *CreateFolderRequest) GetRecursive() bool

func (*CreateFolderRequest) GetRequestId

func (x *CreateFolderRequest) GetRequestId() string

func (*CreateFolderRequest) ProtoMessage

func (*CreateFolderRequest) ProtoMessage()

func (*CreateFolderRequest) ProtoReflect

func (x *CreateFolderRequest) ProtoReflect() protoreflect.Message

func (*CreateFolderRequest) Reset

func (x *CreateFolderRequest) Reset()

func (*CreateFolderRequest) String

func (x *CreateFolderRequest) String() string

type CreateManagedFolderRequest added in v1.41.0

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
}

Request message for CreateManagedFolder.

func (*CreateManagedFolderRequest) Descriptor deprecated added in v1.41.0

func (*CreateManagedFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateManagedFolderRequest.ProtoReflect.Descriptor instead.

func (*CreateManagedFolderRequest) GetManagedFolder added in v1.41.0

func (x *CreateManagedFolderRequest) GetManagedFolder() *ManagedFolder

func (*CreateManagedFolderRequest) GetManagedFolderId added in v1.41.0

func (x *CreateManagedFolderRequest) GetManagedFolderId() string

func (*CreateManagedFolderRequest) GetParent added in v1.41.0

func (x *CreateManagedFolderRequest) GetParent() string

func (*CreateManagedFolderRequest) GetRequestId added in v1.41.0

func (x *CreateManagedFolderRequest) GetRequestId() string

func (*CreateManagedFolderRequest) ProtoMessage added in v1.41.0

func (*CreateManagedFolderRequest) ProtoMessage()

func (*CreateManagedFolderRequest) ProtoReflect added in v1.41.0

func (*CreateManagedFolderRequest) Reset added in v1.41.0

func (x *CreateManagedFolderRequest) Reset()

func (*CreateManagedFolderRequest) String added in v1.41.0

func (x *CreateManagedFolderRequest) String() string

type DeleteFolderRequest

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 `` /* 133-byte string literal not displayed */
	// Makes the operation only succeed conditional on whether the folder's
	// current metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// 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
}

Request message for DeleteFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*DeleteFolderRequest) Descriptor deprecated

func (*DeleteFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFolderRequest.ProtoReflect.Descriptor instead.

func (*DeleteFolderRequest) GetIfMetagenerationMatch

func (x *DeleteFolderRequest) GetIfMetagenerationMatch() int64

func (*DeleteFolderRequest) GetIfMetagenerationNotMatch

func (x *DeleteFolderRequest) GetIfMetagenerationNotMatch() int64

func (*DeleteFolderRequest) GetName

func (x *DeleteFolderRequest) GetName() string

func (*DeleteFolderRequest) GetRequestId

func (x *DeleteFolderRequest) GetRequestId() string

func (*DeleteFolderRequest) ProtoMessage

func (*DeleteFolderRequest) ProtoMessage()

func (*DeleteFolderRequest) ProtoReflect

func (x *DeleteFolderRequest) ProtoReflect() protoreflect.Message

func (*DeleteFolderRequest) Reset

func (x *DeleteFolderRequest) Reset()

func (*DeleteFolderRequest) String

func (x *DeleteFolderRequest) String() string

type DeleteManagedFolderRequest added in v1.41.0

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 `` /* 133-byte string literal not displayed */
	// The operation succeeds conditional on the managed folder's current
	// metageneration NOT matching the value here specified.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// 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
}

DeleteManagedFolder RPC request message.

func (*DeleteManagedFolderRequest) Descriptor deprecated added in v1.41.0

func (*DeleteManagedFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteManagedFolderRequest.ProtoReflect.Descriptor instead.

func (*DeleteManagedFolderRequest) GetAllowNonEmpty added in v1.41.0

func (x *DeleteManagedFolderRequest) GetAllowNonEmpty() bool

func (*DeleteManagedFolderRequest) GetIfMetagenerationMatch added in v1.41.0

func (x *DeleteManagedFolderRequest) GetIfMetagenerationMatch() int64

func (*DeleteManagedFolderRequest) GetIfMetagenerationNotMatch added in v1.41.0

func (x *DeleteManagedFolderRequest) GetIfMetagenerationNotMatch() int64

func (*DeleteManagedFolderRequest) GetName added in v1.41.0

func (x *DeleteManagedFolderRequest) GetName() string

func (*DeleteManagedFolderRequest) GetRequestId added in v1.41.0

func (x *DeleteManagedFolderRequest) GetRequestId() string

func (*DeleteManagedFolderRequest) ProtoMessage added in v1.41.0

func (*DeleteManagedFolderRequest) ProtoMessage()

func (*DeleteManagedFolderRequest) ProtoReflect added in v1.41.0

func (*DeleteManagedFolderRequest) Reset added in v1.41.0

func (x *DeleteManagedFolderRequest) Reset()

func (*DeleteManagedFolderRequest) String added in v1.41.0

func (x *DeleteManagedFolderRequest) String() string

type Folder

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
}

A folder resource. This resource can only exist in a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*Folder) Descriptor deprecated

func (*Folder) Descriptor() ([]byte, []int)

Deprecated: Use Folder.ProtoReflect.Descriptor instead.

func (*Folder) GetCreateTime

func (x *Folder) GetCreateTime() *timestamppb.Timestamp

func (*Folder) GetMetageneration

func (x *Folder) GetMetageneration() int64

func (*Folder) GetName

func (x *Folder) GetName() string

func (*Folder) GetPendingRenameInfo

func (x *Folder) GetPendingRenameInfo() *PendingRenameInfo

func (*Folder) GetUpdateTime

func (x *Folder) GetUpdateTime() *timestamppb.Timestamp

func (*Folder) ProtoMessage

func (*Folder) ProtoMessage()

func (*Folder) ProtoReflect

func (x *Folder) ProtoReflect() protoreflect.Message

func (*Folder) Reset

func (x *Folder) Reset()

func (*Folder) String

func (x *Folder) String() string

type GetFolderRequest

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 `` /* 133-byte string literal not displayed */
	// Makes the operation only succeed conditional on whether the folder's
	// current metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// 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
}

Request message for GetFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*GetFolderRequest) Descriptor deprecated

func (*GetFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFolderRequest.ProtoReflect.Descriptor instead.

func (*GetFolderRequest) GetIfMetagenerationMatch

func (x *GetFolderRequest) GetIfMetagenerationMatch() int64

func (*GetFolderRequest) GetIfMetagenerationNotMatch

func (x *GetFolderRequest) GetIfMetagenerationNotMatch() int64

func (*GetFolderRequest) GetName

func (x *GetFolderRequest) GetName() string

func (*GetFolderRequest) GetRequestId

func (x *GetFolderRequest) GetRequestId() string

func (*GetFolderRequest) ProtoMessage

func (*GetFolderRequest) ProtoMessage()

func (*GetFolderRequest) ProtoReflect

func (x *GetFolderRequest) ProtoReflect() protoreflect.Message

func (*GetFolderRequest) Reset

func (x *GetFolderRequest) Reset()

func (*GetFolderRequest) String

func (x *GetFolderRequest) String() string

type GetManagedFolderRequest added in v1.41.0

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 `` /* 133-byte string literal not displayed */
	// The operation succeeds conditional on the managed folder's current
	// metageneration NOT matching the value here specified.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// 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
}

Request message for GetManagedFolder.

func (*GetManagedFolderRequest) Descriptor deprecated added in v1.41.0

func (*GetManagedFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetManagedFolderRequest.ProtoReflect.Descriptor instead.

func (*GetManagedFolderRequest) GetIfMetagenerationMatch added in v1.41.0

func (x *GetManagedFolderRequest) GetIfMetagenerationMatch() int64

func (*GetManagedFolderRequest) GetIfMetagenerationNotMatch added in v1.41.0

func (x *GetManagedFolderRequest) GetIfMetagenerationNotMatch() int64

func (*GetManagedFolderRequest) GetName added in v1.41.0

func (x *GetManagedFolderRequest) GetName() string

func (*GetManagedFolderRequest) GetRequestId added in v1.41.0

func (x *GetManagedFolderRequest) GetRequestId() string

func (*GetManagedFolderRequest) ProtoMessage added in v1.41.0

func (*GetManagedFolderRequest) ProtoMessage()

func (*GetManagedFolderRequest) ProtoReflect added in v1.41.0

func (x *GetManagedFolderRequest) ProtoReflect() protoreflect.Message

func (*GetManagedFolderRequest) Reset added in v1.41.0

func (x *GetManagedFolderRequest) Reset()

func (*GetManagedFolderRequest) String added in v1.41.0

func (x *GetManagedFolderRequest) String() string

type GetStorageLayoutRequest

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
}

Request message for GetStorageLayout.

func (*GetStorageLayoutRequest) Descriptor deprecated

func (*GetStorageLayoutRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStorageLayoutRequest.ProtoReflect.Descriptor instead.

func (*GetStorageLayoutRequest) GetName

func (x *GetStorageLayoutRequest) GetName() string

func (*GetStorageLayoutRequest) GetPrefix

func (x *GetStorageLayoutRequest) GetPrefix() string

func (*GetStorageLayoutRequest) GetRequestId

func (x *GetStorageLayoutRequest) GetRequestId() string

func (*GetStorageLayoutRequest) ProtoMessage

func (*GetStorageLayoutRequest) ProtoMessage()

func (*GetStorageLayoutRequest) ProtoReflect

func (x *GetStorageLayoutRequest) ProtoReflect() protoreflect.Message

func (*GetStorageLayoutRequest) Reset

func (x *GetStorageLayoutRequest) Reset()

func (*GetStorageLayoutRequest) String

func (x *GetStorageLayoutRequest) String() string

type ListFoldersRequest

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
}

Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*ListFoldersRequest) Descriptor deprecated

func (*ListFoldersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFoldersRequest.ProtoReflect.Descriptor instead.

func (*ListFoldersRequest) GetDelimiter

func (x *ListFoldersRequest) GetDelimiter() string

func (*ListFoldersRequest) GetLexicographicEnd

func (x *ListFoldersRequest) GetLexicographicEnd() string

func (*ListFoldersRequest) GetLexicographicStart

func (x *ListFoldersRequest) GetLexicographicStart() string

func (*ListFoldersRequest) GetPageSize

func (x *ListFoldersRequest) GetPageSize() int32

func (*ListFoldersRequest) GetPageToken

func (x *ListFoldersRequest) GetPageToken() string

func (*ListFoldersRequest) GetParent

func (x *ListFoldersRequest) GetParent() string

func (*ListFoldersRequest) GetPrefix

func (x *ListFoldersRequest) GetPrefix() string

func (*ListFoldersRequest) GetRequestId

func (x *ListFoldersRequest) GetRequestId() string

func (*ListFoldersRequest) ProtoMessage

func (*ListFoldersRequest) ProtoMessage()

func (*ListFoldersRequest) ProtoReflect

func (x *ListFoldersRequest) ProtoReflect() protoreflect.Message

func (*ListFoldersRequest) Reset

func (x *ListFoldersRequest) Reset()

func (*ListFoldersRequest) String

func (x *ListFoldersRequest) String() string

type ListFoldersResponse

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
}

Response message for ListFolders.

func (*ListFoldersResponse) Descriptor deprecated

func (*ListFoldersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFoldersResponse.ProtoReflect.Descriptor instead.

func (*ListFoldersResponse) GetFolders

func (x *ListFoldersResponse) GetFolders() []*Folder

func (*ListFoldersResponse) GetNextPageToken

func (x *ListFoldersResponse) GetNextPageToken() string

func (*ListFoldersResponse) ProtoMessage

func (*ListFoldersResponse) ProtoMessage()

func (*ListFoldersResponse) ProtoReflect

func (x *ListFoldersResponse) ProtoReflect() protoreflect.Message

func (*ListFoldersResponse) Reset

func (x *ListFoldersResponse) Reset()

func (*ListFoldersResponse) String

func (x *ListFoldersResponse) String() string

type ListManagedFoldersRequest added in v1.41.0

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
}

Request message for ListManagedFolders.

func (*ListManagedFoldersRequest) Descriptor deprecated added in v1.41.0

func (*ListManagedFoldersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListManagedFoldersRequest.ProtoReflect.Descriptor instead.

func (*ListManagedFoldersRequest) GetPageSize added in v1.41.0

func (x *ListManagedFoldersRequest) GetPageSize() int32

func (*ListManagedFoldersRequest) GetPageToken added in v1.41.0

func (x *ListManagedFoldersRequest) GetPageToken() string

func (*ListManagedFoldersRequest) GetParent added in v1.41.0

func (x *ListManagedFoldersRequest) GetParent() string

func (*ListManagedFoldersRequest) GetPrefix added in v1.41.0

func (x *ListManagedFoldersRequest) GetPrefix() string

func (*ListManagedFoldersRequest) GetRequestId added in v1.41.0

func (x *ListManagedFoldersRequest) GetRequestId() string

func (*ListManagedFoldersRequest) ProtoMessage added in v1.41.0

func (*ListManagedFoldersRequest) ProtoMessage()

func (*ListManagedFoldersRequest) ProtoReflect added in v1.41.0

func (*ListManagedFoldersRequest) Reset added in v1.41.0

func (x *ListManagedFoldersRequest) Reset()

func (*ListManagedFoldersRequest) String added in v1.41.0

func (x *ListManagedFoldersRequest) String() string

type ListManagedFoldersResponse added in v1.41.0

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
}

Response message for ListManagedFolders.

func (*ListManagedFoldersResponse) Descriptor deprecated added in v1.41.0

func (*ListManagedFoldersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListManagedFoldersResponse.ProtoReflect.Descriptor instead.

func (*ListManagedFoldersResponse) GetManagedFolders added in v1.41.0

func (x *ListManagedFoldersResponse) GetManagedFolders() []*ManagedFolder

func (*ListManagedFoldersResponse) GetNextPageToken added in v1.41.0

func (x *ListManagedFoldersResponse) GetNextPageToken() string

func (*ListManagedFoldersResponse) ProtoMessage added in v1.41.0

func (*ListManagedFoldersResponse) ProtoMessage()

func (*ListManagedFoldersResponse) ProtoReflect added in v1.41.0

func (*ListManagedFoldersResponse) Reset added in v1.41.0

func (x *ListManagedFoldersResponse) Reset()

func (*ListManagedFoldersResponse) String added in v1.41.0

func (x *ListManagedFoldersResponse) String() string

type ManagedFolder added in v1.41.0

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
}

A managed folder.

func (*ManagedFolder) Descriptor deprecated added in v1.41.0

func (*ManagedFolder) Descriptor() ([]byte, []int)

Deprecated: Use ManagedFolder.ProtoReflect.Descriptor instead.

func (*ManagedFolder) GetCreateTime added in v1.41.0

func (x *ManagedFolder) GetCreateTime() *timestamppb.Timestamp

func (*ManagedFolder) GetMetageneration added in v1.41.0

func (x *ManagedFolder) GetMetageneration() int64

func (*ManagedFolder) GetName added in v1.41.0

func (x *ManagedFolder) GetName() string

func (*ManagedFolder) GetUpdateTime added in v1.41.0

func (x *ManagedFolder) GetUpdateTime() *timestamppb.Timestamp

func (*ManagedFolder) ProtoMessage added in v1.41.0

func (*ManagedFolder) ProtoMessage()

func (*ManagedFolder) ProtoReflect added in v1.41.0

func (x *ManagedFolder) ProtoReflect() protoreflect.Message

func (*ManagedFolder) Reset added in v1.41.0

func (x *ManagedFolder) Reset()

func (*ManagedFolder) String added in v1.41.0

func (x *ManagedFolder) String() string

type PendingRenameInfo

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
}

Contains information about a pending rename operation.

func (*PendingRenameInfo) Descriptor deprecated

func (*PendingRenameInfo) Descriptor() ([]byte, []int)

Deprecated: Use PendingRenameInfo.ProtoReflect.Descriptor instead.

func (*PendingRenameInfo) GetOperation

func (x *PendingRenameInfo) GetOperation() string

func (*PendingRenameInfo) ProtoMessage

func (*PendingRenameInfo) ProtoMessage()

func (*PendingRenameInfo) ProtoReflect

func (x *PendingRenameInfo) ProtoReflect() protoreflect.Message

func (*PendingRenameInfo) Reset

func (x *PendingRenameInfo) Reset()

func (*PendingRenameInfo) String

func (x *PendingRenameInfo) String() string

type RenameFolderMetadata

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
}

Message returned in the metadata field of the Operation resource for RenameFolder operations.

func (*RenameFolderMetadata) Descriptor deprecated

func (*RenameFolderMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RenameFolderMetadata.ProtoReflect.Descriptor instead.

func (*RenameFolderMetadata) GetCommonMetadata

func (*RenameFolderMetadata) GetDestinationFolderId

func (x *RenameFolderMetadata) GetDestinationFolderId() string

func (*RenameFolderMetadata) GetSourceFolderId

func (x *RenameFolderMetadata) GetSourceFolderId() string

func (*RenameFolderMetadata) ProtoMessage

func (*RenameFolderMetadata) ProtoMessage()

func (*RenameFolderMetadata) ProtoReflect

func (x *RenameFolderMetadata) ProtoReflect() protoreflect.Message

func (*RenameFolderMetadata) Reset

func (x *RenameFolderMetadata) Reset()

func (*RenameFolderMetadata) String

func (x *RenameFolderMetadata) String() string

type RenameFolderRequest

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 `` /* 133-byte string literal not displayed */
	// Makes the operation only succeed conditional on whether the source
	// folder's current metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// 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
}

Request message for RenameFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

func (*RenameFolderRequest) Descriptor deprecated

func (*RenameFolderRequest) Descriptor() ([]byte, []int)

Deprecated: Use RenameFolderRequest.ProtoReflect.Descriptor instead.

func (*RenameFolderRequest) GetDestinationFolderId

func (x *RenameFolderRequest) GetDestinationFolderId() string

func (*RenameFolderRequest) GetIfMetagenerationMatch

func (x *RenameFolderRequest) GetIfMetagenerationMatch() int64

func (*RenameFolderRequest) GetIfMetagenerationNotMatch

func (x *RenameFolderRequest) GetIfMetagenerationNotMatch() int64

func (*RenameFolderRequest) GetName

func (x *RenameFolderRequest) GetName() string

func (*RenameFolderRequest) GetRequestId

func (x *RenameFolderRequest) GetRequestId() string

func (*RenameFolderRequest) ProtoMessage

func (*RenameFolderRequest) ProtoMessage()

func (*RenameFolderRequest) ProtoReflect

func (x *RenameFolderRequest) ProtoReflect() protoreflect.Message

func (*RenameFolderRequest) Reset

func (x *RenameFolderRequest) Reset()

func (*RenameFolderRequest) String

func (x *RenameFolderRequest) String() string

type StorageControlClient

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)
}

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 StorageControlServer

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)
}

StorageControlServer is the server API for StorageControl service.

type StorageLayout

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 `` /* 126-byte string literal not displayed */
	// 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
}

The storage layout configuration of a bucket.

func (*StorageLayout) Descriptor deprecated

func (*StorageLayout) Descriptor() ([]byte, []int)

Deprecated: Use StorageLayout.ProtoReflect.Descriptor instead.

func (*StorageLayout) GetCustomPlacementConfig

func (x *StorageLayout) GetCustomPlacementConfig() *StorageLayout_CustomPlacementConfig

func (*StorageLayout) GetHierarchicalNamespace

func (x *StorageLayout) GetHierarchicalNamespace() *StorageLayout_HierarchicalNamespace

func (*StorageLayout) GetLocation

func (x *StorageLayout) GetLocation() string

func (*StorageLayout) GetLocationType

func (x *StorageLayout) GetLocationType() string

func (*StorageLayout) GetName

func (x *StorageLayout) GetName() string

func (*StorageLayout) ProtoMessage

func (*StorageLayout) ProtoMessage()

func (*StorageLayout) ProtoReflect

func (x *StorageLayout) ProtoReflect() protoreflect.Message

func (*StorageLayout) Reset

func (x *StorageLayout) Reset()

func (*StorageLayout) String

func (x *StorageLayout) String() string

type StorageLayout_CustomPlacementConfig

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
}

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].

func (*StorageLayout_CustomPlacementConfig) Descriptor deprecated

func (*StorageLayout_CustomPlacementConfig) Descriptor() ([]byte, []int)

Deprecated: Use StorageLayout_CustomPlacementConfig.ProtoReflect.Descriptor instead.

func (*StorageLayout_CustomPlacementConfig) GetDataLocations

func (x *StorageLayout_CustomPlacementConfig) GetDataLocations() []string

func (*StorageLayout_CustomPlacementConfig) ProtoMessage

func (*StorageLayout_CustomPlacementConfig) ProtoMessage()

func (*StorageLayout_CustomPlacementConfig) ProtoReflect

func (*StorageLayout_CustomPlacementConfig) Reset

func (*StorageLayout_CustomPlacementConfig) String

type StorageLayout_HierarchicalNamespace

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
}

Configuration for a bucket's hierarchical namespace feature.

func (*StorageLayout_HierarchicalNamespace) Descriptor deprecated

func (*StorageLayout_HierarchicalNamespace) Descriptor() ([]byte, []int)

Deprecated: Use StorageLayout_HierarchicalNamespace.ProtoReflect.Descriptor instead.

func (*StorageLayout_HierarchicalNamespace) GetEnabled

func (x *StorageLayout_HierarchicalNamespace) GetEnabled() bool

func (*StorageLayout_HierarchicalNamespace) ProtoMessage

func (*StorageLayout_HierarchicalNamespace) ProtoMessage()

func (*StorageLayout_HierarchicalNamespace) ProtoReflect

func (*StorageLayout_HierarchicalNamespace) Reset

func (*StorageLayout_HierarchicalNamespace) String

type UnimplementedStorageControlServer

type UnimplementedStorageControlServer struct {
}

UnimplementedStorageControlServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageControlServer) CreateFolder

func (*UnimplementedStorageControlServer) CreateManagedFolder added in v1.41.0

func (*UnimplementedStorageControlServer) DeleteFolder

func (*UnimplementedStorageControlServer) DeleteManagedFolder added in v1.41.0

func (*UnimplementedStorageControlServer) GetFolder

func (*UnimplementedStorageControlServer) GetManagedFolder added in v1.41.0

func (*UnimplementedStorageControlServer) GetStorageLayout

func (*UnimplementedStorageControlServer) ListFolders

func (*UnimplementedStorageControlServer) ListManagedFolders added in v1.41.0

func (*UnimplementedStorageControlServer) RenameFolder

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL