Enum value maps for Folder_LifecycleState.
var (
Folder_LifecycleState_name = map[int32]string{
0: "LIFECYCLE_STATE_UNSPECIFIED",
1: "ACTIVE",
2: "DELETE_REQUESTED",
}
Folder_LifecycleState_value = map[string]int32{
"LIFECYCLE_STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"DELETE_REQUESTED": 2,
}
)
Enum value maps for FolderOperation_OperationType.
var (
FolderOperation_OperationType_name = map[int32]string{
0: "OPERATION_TYPE_UNSPECIFIED",
1: "CREATE",
2: "MOVE",
}
FolderOperation_OperationType_value = map[string]int32{
"OPERATION_TYPE_UNSPECIFIED": 0,
"CREATE": 1,
"MOVE": 2,
}
)
var File_google_cloud_resourcemanager_v2_folders_proto protoreflect.FileDescriptor
func RegisterFoldersServer(s *grpc.Server, srv FoldersServer)
The CreateFolder request message.
type CreateFolderRequest struct {
// Required. The resource name of the new Folder's parent.
// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The Folder being created, only the display name will be consulted.
// All other fields will be ignored.
Folder *Folder `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,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) GetParent() string
func (*CreateFolderRequest) ProtoMessage()
func (x *CreateFolderRequest) ProtoReflect() protoreflect.Message
func (x *CreateFolderRequest) Reset()
func (x *CreateFolderRequest) String() string
The DeleteFolder request message.
type DeleteFolderRequest struct {
// Required. The resource name of the Folder to be deleted.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Instructs DeleteFolderAction to delete a folder even when the folder is not
// empty.
RecursiveDelete bool `protobuf:"varint,2,opt,name=recursive_delete,json=recursiveDelete,proto3" json:"recursive_delete,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderRequest.ProtoReflect.Descriptor instead.
func (x *DeleteFolderRequest) GetName() string
func (x *DeleteFolderRequest) GetRecursiveDelete() bool
func (*DeleteFolderRequest) ProtoMessage()
func (x *DeleteFolderRequest) ProtoReflect() protoreflect.Message
func (x *DeleteFolderRequest) Reset()
func (x *DeleteFolderRequest) String() string
A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.
type Folder struct {
// Output only. The resource name of the Folder.
// Its format is `folders/{folder_id}`, for example: "folders/1234".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The Folder’s parent's resource name.
// Updates to the folder's parent must be performed via
// [MoveFolder][google.cloud.resourcemanager.v2.Folders.MoveFolder].
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// The folder’s display name.
// A folder’s display name must be unique amongst its siblings, e.g.
// no two folders with the same parent can share the same display name.
// The display name must start and end with a letter or digit, may contain
// letters, digits, spaces, hyphens and underscores and can be no longer
// than 30 characters. This is captured by the regular expression:
// [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. The lifecycle state of the folder.
// Updates to the lifecycle_state must be performed via
// [DeleteFolder][google.cloud.resourcemanager.v2.Folders.DeleteFolder] and
// [UndeleteFolder][google.cloud.resourcemanager.v2.Folders.UndeleteFolder].
LifecycleState Folder_LifecycleState `protobuf:"varint,4,opt,name=lifecycle_state,json=lifecycleState,proto3,enum=google.cloud.resourcemanager.v2.Folder_LifecycleState" json:"lifecycle_state,omitempty"`
// Output only. Timestamp when the Folder was created. Assigned by the server.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the Folder was last modified.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,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) GetDisplayName() string
func (x *Folder) GetLifecycleState() Folder_LifecycleState
func (x *Folder) GetName() string
func (x *Folder) GetParent() string
func (x *Folder) GetUpdateTime() *timestamppb.Timestamp
func (*Folder) ProtoMessage()
func (x *Folder) ProtoReflect() protoreflect.Message
func (x *Folder) Reset()
func (x *Folder) String() string
Metadata describing a long running folder operation
type FolderOperation struct {
// The display name of the folder.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The type of this operation.
OperationType FolderOperation_OperationType `protobuf:"varint,2,opt,name=operation_type,json=operationType,proto3,enum=google.cloud.resourcemanager.v2.FolderOperation_OperationType" json:"operation_type,omitempty"`
// The resource name of the folder's parent.
// Only applicable when the operation_type is MOVE.
SourceParent string `protobuf:"bytes,3,opt,name=source_parent,json=sourceParent,proto3" json:"source_parent,omitempty"`
// The resource name of the folder or organization we are either creating
// the folder under or moving the folder to.
DestinationParent string `protobuf:"bytes,4,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
// contains filtered or unexported fields
}
func (*FolderOperation) Descriptor() ([]byte, []int)
Deprecated: Use FolderOperation.ProtoReflect.Descriptor instead.
func (x *FolderOperation) GetDestinationParent() string
func (x *FolderOperation) GetDisplayName() string
func (x *FolderOperation) GetOperationType() FolderOperation_OperationType
func (x *FolderOperation) GetSourceParent() string
func (*FolderOperation) ProtoMessage()
func (x *FolderOperation) ProtoReflect() protoreflect.Message
func (x *FolderOperation) Reset()
func (x *FolderOperation) String() string
The type of operation that failed.
type FolderOperation_OperationType int32
const (
// Operation type not specified.
FolderOperation_OPERATION_TYPE_UNSPECIFIED FolderOperation_OperationType = 0
// A create folder operation.
FolderOperation_CREATE FolderOperation_OperationType = 1
// A move folder operation.
FolderOperation_MOVE FolderOperation_OperationType = 2
)
func (FolderOperation_OperationType) Descriptor() protoreflect.EnumDescriptor
func (x FolderOperation_OperationType) Enum() *FolderOperation_OperationType
func (FolderOperation_OperationType) EnumDescriptor() ([]byte, []int)
Deprecated: Use FolderOperation_OperationType.Descriptor instead.
func (x FolderOperation_OperationType) Number() protoreflect.EnumNumber
func (x FolderOperation_OperationType) String() string
func (FolderOperation_OperationType) Type() protoreflect.EnumType
Folder lifecycle states.
type Folder_LifecycleState int32
const (
// Unspecified state.
Folder_LIFECYCLE_STATE_UNSPECIFIED Folder_LifecycleState = 0
// The normal and active state.
Folder_ACTIVE Folder_LifecycleState = 1
// The folder has been marked for deletion by the user.
Folder_DELETE_REQUESTED Folder_LifecycleState = 2
)
func (Folder_LifecycleState) Descriptor() protoreflect.EnumDescriptor
func (x Folder_LifecycleState) Enum() *Folder_LifecycleState
func (Folder_LifecycleState) EnumDescriptor() ([]byte, []int)
Deprecated: Use Folder_LifecycleState.Descriptor instead.
func (x Folder_LifecycleState) Number() protoreflect.EnumNumber
func (x Folder_LifecycleState) String() string
func (Folder_LifecycleState) Type() protoreflect.EnumType
FoldersClient is the client API for Folders service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type FoldersClient interface {
// Lists the Folders that are direct descendants of supplied parent resource.
// List provides a strongly consistent view of the Folders underneath
// the specified parent resource.
// List returns Folders sorted based upon the (ascending) lexical ordering
// of their display_name.
// The caller must have `resourcemanager.folders.list` permission on the
// identified parent.
ListFolders(ctx context.Context, in *ListFoldersRequest, opts ...grpc.CallOption) (*ListFoldersResponse, error)
// Search for folders that match specific filter criteria.
// Search provides an eventually consistent view of the folders a user has
// access to which meet the specified filter criteria.
//
// This will only return folders on which the caller has the
// permission `resourcemanager.folders.get`.
SearchFolders(ctx context.Context, in *SearchFoldersRequest, opts ...grpc.CallOption) (*SearchFoldersResponse, error)
// Retrieves a Folder identified by the supplied resource name.
// Valid Folder resource names have the format `folders/{folder_id}`
// (for example, `folders/1234`).
// The caller must have `resourcemanager.folders.get` permission on the
// identified folder.
GetFolder(ctx context.Context, in *GetFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Creates a Folder in the resource hierarchy.
// Returns an Operation which can be used to track the progress of the
// folder creation workflow.
// Upon success the Operation.response field will be populated with the
// created Folder.
//
// In order to succeed, the addition of this new Folder must not violate
// the Folder naming, height or fanout constraints.
//
// + The Folder's display_name must be distinct from all other Folder's that
// share its parent.
// + The addition of the Folder must not cause the active Folder hierarchy
// to exceed a height of 4. Note, the full active + deleted Folder hierarchy
// is allowed to reach a height of 8; this provides additional headroom when
// moving folders that contain deleted folders.
// + The addition of the Folder must not cause the total number of Folders
// under its parent to exceed 100.
//
// If the operation fails due to a folder constraint violation, some errors
// may be returned by the CreateFolder request, with status code
// FAILED_PRECONDITION and an error description. Other folder constraint
// violations will be communicated in the Operation, with the specific
// PreconditionFailure returned via the details list in the Operation.error
// field.
//
// The caller must have `resourcemanager.folders.create` permission on the
// identified parent.
CreateFolder(ctx context.Context, in *CreateFolderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a Folder, changing its display_name.
// Changes to the folder display_name will be rejected if they violate either
// the display_name formatting rules or naming constraints described in
// the [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
//
// The Folder's display name must start and end with a letter or digit,
// may contain letters, digits, spaces, hyphens and underscores and can be
// no longer than 30 characters. This is captured by the regular expression:
// [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
// The caller must have `resourcemanager.folders.update` permission on the
// identified folder.
//
// If the update fails due to the unique name constraint then a
// PreconditionFailure explaining this violation will be returned
// in the Status.details field.
UpdateFolder(ctx context.Context, in *UpdateFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Moves a Folder under a new resource parent.
// Returns an Operation which can be used to track the progress of the
// folder move workflow.
// Upon success the Operation.response field will be populated with the
// moved Folder.
// Upon failure, a FolderOperationError categorizing the failure cause will
// be returned - if the failure occurs synchronously then the
// FolderOperationError will be returned via the Status.details field
// and if it occurs asynchronously then the FolderOperation will be returned
// via the Operation.error field.
// In addition, the Operation.metadata field will be populated with a
// FolderOperation message as an aid to stateless clients.
// Folder moves will be rejected if they violate either the naming, height
// or fanout constraints described in the
// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.move` permission on the
// folder's current and proposed new parent.
MoveFolder(ctx context.Context, in *MoveFolderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Requests deletion of a Folder. The Folder is moved into the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state
// immediately, and is deleted approximately 30 days later. This method may
// only be called on an empty Folder in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state, where a Folder is empty if
// it doesn't contain any Folders or Projects in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
// The caller must have `resourcemanager.folders.delete` permission on the
// identified folder.
DeleteFolder(ctx context.Context, in *DeleteFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Cancels the deletion request for a Folder. This method may only be
// called on a Folder in the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state.
// In order to succeed, the Folder's parent must be in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
// In addition, reintroducing the folder into the tree must not violate
// folder naming, height and fanout constraints described in the
// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.undelete` permission on the
// identified folder.
UndeleteFolder(ctx context.Context, in *UndeleteFolderRequest, opts ...grpc.CallOption) (*Folder, error)
// Gets the access control policy for a Folder. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the Folder's resource name, e.g. "folders/1234".
// The caller must have `resourcemanager.folders.getIamPolicy` permission
// on the identified folder.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on a Folder, replacing any existing policy.
// The `resource` field should be the Folder's resource name, e.g.
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified Folder.
// The `resource` field should be the Folder's resource name,
// e.g. "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewFoldersClient(cc grpc.ClientConnInterface) FoldersClient
FoldersServer is the server API for Folders service.
type FoldersServer interface {
// Lists the Folders that are direct descendants of supplied parent resource.
// List provides a strongly consistent view of the Folders underneath
// the specified parent resource.
// List returns Folders sorted based upon the (ascending) lexical ordering
// of their display_name.
// The caller must have `resourcemanager.folders.list` permission on the
// identified parent.
ListFolders(context.Context, *ListFoldersRequest) (*ListFoldersResponse, error)
// Search for folders that match specific filter criteria.
// Search provides an eventually consistent view of the folders a user has
// access to which meet the specified filter criteria.
//
// This will only return folders on which the caller has the
// permission `resourcemanager.folders.get`.
SearchFolders(context.Context, *SearchFoldersRequest) (*SearchFoldersResponse, error)
// Retrieves a Folder identified by the supplied resource name.
// Valid Folder resource names have the format `folders/{folder_id}`
// (for example, `folders/1234`).
// The caller must have `resourcemanager.folders.get` permission on the
// identified folder.
GetFolder(context.Context, *GetFolderRequest) (*Folder, error)
// Creates a Folder in the resource hierarchy.
// Returns an Operation which can be used to track the progress of the
// folder creation workflow.
// Upon success the Operation.response field will be populated with the
// created Folder.
//
// In order to succeed, the addition of this new Folder must not violate
// the Folder naming, height or fanout constraints.
//
// + The Folder's display_name must be distinct from all other Folder's that
// share its parent.
// + The addition of the Folder must not cause the active Folder hierarchy
// to exceed a height of 4. Note, the full active + deleted Folder hierarchy
// is allowed to reach a height of 8; this provides additional headroom when
// moving folders that contain deleted folders.
// + The addition of the Folder must not cause the total number of Folders
// under its parent to exceed 100.
//
// If the operation fails due to a folder constraint violation, some errors
// may be returned by the CreateFolder request, with status code
// FAILED_PRECONDITION and an error description. Other folder constraint
// violations will be communicated in the Operation, with the specific
// PreconditionFailure returned via the details list in the Operation.error
// field.
//
// The caller must have `resourcemanager.folders.create` permission on the
// identified parent.
CreateFolder(context.Context, *CreateFolderRequest) (*longrunningpb.Operation, error)
// Updates a Folder, changing its display_name.
// Changes to the folder display_name will be rejected if they violate either
// the display_name formatting rules or naming constraints described in
// the [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
//
// The Folder's display name must start and end with a letter or digit,
// may contain letters, digits, spaces, hyphens and underscores and can be
// no longer than 30 characters. This is captured by the regular expression:
// [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
// The caller must have `resourcemanager.folders.update` permission on the
// identified folder.
//
// If the update fails due to the unique name constraint then a
// PreconditionFailure explaining this violation will be returned
// in the Status.details field.
UpdateFolder(context.Context, *UpdateFolderRequest) (*Folder, error)
// Moves a Folder under a new resource parent.
// Returns an Operation which can be used to track the progress of the
// folder move workflow.
// Upon success the Operation.response field will be populated with the
// moved Folder.
// Upon failure, a FolderOperationError categorizing the failure cause will
// be returned - if the failure occurs synchronously then the
// FolderOperationError will be returned via the Status.details field
// and if it occurs asynchronously then the FolderOperation will be returned
// via the Operation.error field.
// In addition, the Operation.metadata field will be populated with a
// FolderOperation message as an aid to stateless clients.
// Folder moves will be rejected if they violate either the naming, height
// or fanout constraints described in the
// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.move` permission on the
// folder's current and proposed new parent.
MoveFolder(context.Context, *MoveFolderRequest) (*longrunningpb.Operation, error)
// Requests deletion of a Folder. The Folder is moved into the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state
// immediately, and is deleted approximately 30 days later. This method may
// only be called on an empty Folder in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state, where a Folder is empty if
// it doesn't contain any Folders or Projects in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
// The caller must have `resourcemanager.folders.delete` permission on the
// identified folder.
DeleteFolder(context.Context, *DeleteFolderRequest) (*Folder, error)
// Cancels the deletion request for a Folder. This method may only be
// called on a Folder in the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state.
// In order to succeed, the Folder's parent must be in the
// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
// In addition, reintroducing the folder into the tree must not violate
// folder naming, height and fanout constraints described in the
// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.undelete` permission on the
// identified folder.
UndeleteFolder(context.Context, *UndeleteFolderRequest) (*Folder, error)
// Gets the access control policy for a Folder. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the Folder's resource name, e.g. "folders/1234".
// The caller must have `resourcemanager.folders.getIamPolicy` permission
// on the identified folder.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on a Folder, replacing any existing policy.
// The `resource` field should be the Folder's resource name, e.g.
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified Folder.
// The `resource` field should be the Folder's resource name,
// e.g. "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
The GetFolder request message.
type GetFolderRequest struct {
// Required. The resource name of the Folder to retrieve.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFolderRequest.ProtoReflect.Descriptor instead.
func (x *GetFolderRequest) GetName() string
func (*GetFolderRequest) ProtoMessage()
func (x *GetFolderRequest) ProtoReflect() protoreflect.Message
func (x *GetFolderRequest) Reset()
func (x *GetFolderRequest) String() string
The ListFolders request message.
type ListFoldersRequest struct {
// Required. The resource name of the Organization or Folder whose Folders are
// being listed.
// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
// Access to this method is controlled by checking the
// `resourcemanager.folders.list` permission on the `parent`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of Folders to return in the response.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A pagination token returned from a previous call to `ListFolders`
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Controls whether Folders in the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED]
// state should be returned. Defaults to false.
ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
// contains filtered or unexported fields
}
func (*ListFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersRequest.ProtoReflect.Descriptor instead.
func (x *ListFoldersRequest) GetPageSize() int32
func (x *ListFoldersRequest) GetPageToken() string
func (x *ListFoldersRequest) GetParent() string
func (x *ListFoldersRequest) GetShowDeleted() bool
func (*ListFoldersRequest) ProtoMessage()
func (x *ListFoldersRequest) ProtoReflect() protoreflect.Message
func (x *ListFoldersRequest) Reset()
func (x *ListFoldersRequest) String() string
The ListFolders response message.
type ListFoldersResponse struct {
// A possibly paginated list of Folders that are direct descendants of
// the specified parent resource.
Folders []*Folder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
// A pagination token returned from a previous call to `ListFolders`
// that indicates from where listing should continue.
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
The MoveFolder request message.
type MoveFolderRequest struct {
// Required. The resource name of the Folder to move.
// Must be of the form folders/{folder_id}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The resource name of the Folder or Organization to reparent
// the folder under.
// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
DestinationParent string `protobuf:"bytes,2,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
// contains filtered or unexported fields
}
func (*MoveFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveFolderRequest.ProtoReflect.Descriptor instead.
func (x *MoveFolderRequest) GetDestinationParent() string
func (x *MoveFolderRequest) GetName() string
func (*MoveFolderRequest) ProtoMessage()
func (x *MoveFolderRequest) ProtoReflect() protoreflect.Message
func (x *MoveFolderRequest) Reset()
func (x *MoveFolderRequest) String() string
The request message for searching folders.
type SearchFoldersRequest struct {
// Optional. The maximum number of folders to return in the response.
PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A pagination token returned from a previous call to `SearchFolders`
// that indicates from where search should continue.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Search criteria used to select the Folders to return.
// If no search criteria is specified then all accessible folders will be
// returned.
//
// Query expressions can be used to restrict results based upon displayName,
// lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
// can be used along with the suffix wildcard symbol `*`.
//
// The displayName field in a query expression should use escaped quotes
// for values that include whitespace to prevent unexpected behavior.
//
// Some example queries are:
//
// * Query `displayName=Test*` returns Folder resources whose display name
// starts with "Test".
// * Query `lifecycleState=ACTIVE` returns Folder resources with
// `lifecycleState` set to `ACTIVE`.
// * Query `parent=folders/123` returns Folder resources that have
// `folders/123` as a parent resource.
// * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active
// Folder resources that have `folders/123` as a parent resource.
// * Query `displayName=\\"Test String\\"` returns Folder resources with
// display names that include both "Test" and "String".
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
// contains filtered or unexported fields
}
func (*SearchFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersRequest.ProtoReflect.Descriptor instead.
func (x *SearchFoldersRequest) GetPageSize() int32
func (x *SearchFoldersRequest) GetPageToken() string
func (x *SearchFoldersRequest) GetQuery() string
func (*SearchFoldersRequest) ProtoMessage()
func (x *SearchFoldersRequest) ProtoReflect() protoreflect.Message
func (x *SearchFoldersRequest) Reset()
func (x *SearchFoldersRequest) String() string
The response message for searching folders.
type SearchFoldersResponse struct {
// A possibly paginated folder search results.
// the specified parent resource.
Folders []*Folder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
// A pagination token returned from a previous call to `SearchFolders`
// that indicates from where searching should continue.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*SearchFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersResponse.ProtoReflect.Descriptor instead.
func (x *SearchFoldersResponse) GetFolders() []*Folder
func (x *SearchFoldersResponse) GetNextPageToken() string
func (*SearchFoldersResponse) ProtoMessage()
func (x *SearchFoldersResponse) ProtoReflect() protoreflect.Message
func (x *SearchFoldersResponse) Reset()
func (x *SearchFoldersResponse) String() string
The UndeleteFolder request message.
type UndeleteFolderRequest struct {
// Required. The resource name of the Folder to undelete.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*UndeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteFolderRequest.ProtoReflect.Descriptor instead.
func (x *UndeleteFolderRequest) GetName() string
func (*UndeleteFolderRequest) ProtoMessage()
func (x *UndeleteFolderRequest) ProtoReflect() protoreflect.Message
func (x *UndeleteFolderRequest) Reset()
func (x *UndeleteFolderRequest) String() string
UnimplementedFoldersServer can be embedded to have forward compatible implementations.
type UnimplementedFoldersServer struct {
}
func (*UnimplementedFoldersServer) CreateFolder(context.Context, *CreateFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) DeleteFolder(context.Context, *DeleteFolderRequest) (*Folder, error)
func (*UnimplementedFoldersServer) GetFolder(context.Context, *GetFolderRequest) (*Folder, error)
func (*UnimplementedFoldersServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedFoldersServer) ListFolders(context.Context, *ListFoldersRequest) (*ListFoldersResponse, error)
func (*UnimplementedFoldersServer) MoveFolder(context.Context, *MoveFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) SearchFolders(context.Context, *SearchFoldersRequest) (*SearchFoldersResponse, error)
func (*UnimplementedFoldersServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedFoldersServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedFoldersServer) UndeleteFolder(context.Context, *UndeleteFolderRequest) (*Folder, error)
func (*UnimplementedFoldersServer) UpdateFolder(context.Context, *UpdateFolderRequest) (*Folder, error)
The request message for updating a folder's display name.
type UpdateFolderRequest struct {
// Required. The new definition of the Folder. It must include a
// a `name` and `display_name` field. The other fields
// will be ignored.
Folder *Folder `protobuf:"bytes,1,opt,name=folder,proto3" json:"folder,omitempty"`
// Required. Fields to be updated.
// Only the `display_name` can be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateFolderRequest.ProtoReflect.Descriptor instead.
func (x *UpdateFolderRequest) GetFolder() *Folder
func (x *UpdateFolderRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateFolderRequest) ProtoMessage()
func (x *UpdateFolderRequest) ProtoReflect() protoreflect.Message
func (x *UpdateFolderRequest) Reset()
func (x *UpdateFolderRequest) String() string