Variables
Folder_State_name, Folder_State_value
var (
Folder_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "DELETE_REQUESTED",
}
Folder_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"DELETE_REQUESTED": 2,
}
)
Enum value maps for Folder_State.
Organization_State_name, Organization_State_value
var (
Organization_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "DELETE_REQUESTED",
}
Organization_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"DELETE_REQUESTED": 2,
}
)
Enum value maps for Organization_State.
Project_State_name, Project_State_value
var (
Project_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "DELETE_REQUESTED",
}
Project_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"DELETE_REQUESTED": 2,
}
)
Enum value maps for Project_State.
File_google_cloud_resourcemanager_v3_folders_proto
var File_google_cloud_resourcemanager_v3_folders_proto protoreflect.FileDescriptor
File_google_cloud_resourcemanager_v3_organizations_proto
var File_google_cloud_resourcemanager_v3_organizations_proto protoreflect.FileDescriptor
File_google_cloud_resourcemanager_v3_projects_proto
var File_google_cloud_resourcemanager_v3_projects_proto protoreflect.FileDescriptor
File_google_cloud_resourcemanager_v3_tag_bindings_proto
var File_google_cloud_resourcemanager_v3_tag_bindings_proto protoreflect.FileDescriptor
File_google_cloud_resourcemanager_v3_tag_keys_proto
var File_google_cloud_resourcemanager_v3_tag_keys_proto protoreflect.FileDescriptor
File_google_cloud_resourcemanager_v3_tag_values_proto
var File_google_cloud_resourcemanager_v3_tag_values_proto protoreflect.FileDescriptor
Functions
func RegisterFoldersServer
func RegisterFoldersServer(s *grpc.Server, srv FoldersServer)
func RegisterOrganizationsServer
func RegisterOrganizationsServer(s *grpc.Server, srv OrganizationsServer)
func RegisterProjectsServer
func RegisterProjectsServer(s *grpc.Server, srv ProjectsServer)
func RegisterTagBindingsServer
func RegisterTagBindingsServer(s *grpc.Server, srv TagBindingsServer)
func RegisterTagKeysServer
func RegisterTagKeysServer(s *grpc.Server, srv TagKeysServer)
func RegisterTagValuesServer
func RegisterTagValuesServer(s *grpc.Server, srv TagValuesServer)
CreateFolderMetadata
type CreateFolderMetadata struct {
// The display name of the folder.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The resource name of the folder or organization we are creating the folder
// under.
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}
Metadata pertaining to the Folder creation process.
func (*CreateFolderMetadata) Descriptor
func (*CreateFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateFolderMetadata.ProtoReflect.Descriptor instead.
func (*CreateFolderMetadata) GetDisplayName
func (x *CreateFolderMetadata) GetDisplayName() string
func (*CreateFolderMetadata) GetParent
func (x *CreateFolderMetadata) GetParent() string
func (*CreateFolderMetadata) ProtoMessage
func (*CreateFolderMetadata) ProtoMessage()
func (*CreateFolderMetadata) ProtoReflect
func (x *CreateFolderMetadata) ProtoReflect() protoreflect.Message
func (*CreateFolderMetadata) Reset
func (x *CreateFolderMetadata) Reset()
func (*CreateFolderMetadata) String
func (x *CreateFolderMetadata) String() string
CreateFolderRequest
type CreateFolderRequest struct {
// Required. The folder being created, only the display name and parent 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
}
The CreateFolder request message.
func (*CreateFolderRequest) Descriptor
func (*CreateFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFolderRequest.ProtoReflect.Descriptor instead.
func (*CreateFolderRequest) GetFolder
func (x *CreateFolderRequest) GetFolder() *Folder
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
CreateProjectMetadata
type CreateProjectMetadata struct {
// Creation time of the project creation workflow.
CreateTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// True if the project can be retrieved using `GetProject`. No other
// operations on the project are guaranteed to work until the project creation
// is complete.
Gettable bool `protobuf:"varint,2,opt,name=gettable,proto3" json:"gettable,omitempty"`
// True if the project creation process is complete.
Ready bool `protobuf:"varint,3,opt,name=ready,proto3" json:"ready,omitempty"`
// contains filtered or unexported fields
}
A status object which is used as the metadata
field for the Operation
returned by CreateProject. It provides insight for when significant phases of
Project creation have completed.
func (*CreateProjectMetadata) Descriptor
func (*CreateProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectMetadata.ProtoReflect.Descriptor instead.
func (*CreateProjectMetadata) GetCreateTime
func (x *CreateProjectMetadata) GetCreateTime() *timestamp.Timestamp
func (*CreateProjectMetadata) GetGettable
func (x *CreateProjectMetadata) GetGettable() bool
func (*CreateProjectMetadata) GetReady
func (x *CreateProjectMetadata) GetReady() bool
func (*CreateProjectMetadata) ProtoMessage
func (*CreateProjectMetadata) ProtoMessage()
func (*CreateProjectMetadata) ProtoReflect
func (x *CreateProjectMetadata) ProtoReflect() protoreflect.Message
func (*CreateProjectMetadata) Reset
func (x *CreateProjectMetadata) Reset()
func (*CreateProjectMetadata) String
func (x *CreateProjectMetadata) String() string
CreateProjectRequest
type CreateProjectRequest struct {
// Required. The Project to create.
//
// Project ID is required. If the requested ID is unavailable, the request
// fails.
//
// If the `parent` field is set, the `resourcemanager.projects.create`
// permission is checked on the parent resource. If no parent is set and
// the authorization credentials belong to an Organziation, the parent
// will be set to that Organization.
Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// contains filtered or unexported fields
}
The request sent to the [CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject] method.
func (*CreateProjectRequest) Descriptor
func (*CreateProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectRequest.ProtoReflect.Descriptor instead.
func (*CreateProjectRequest) GetProject
func (x *CreateProjectRequest) GetProject() *Project
func (*CreateProjectRequest) ProtoMessage
func (*CreateProjectRequest) ProtoMessage()
func (*CreateProjectRequest) ProtoReflect
func (x *CreateProjectRequest) ProtoReflect() protoreflect.Message
func (*CreateProjectRequest) Reset
func (x *CreateProjectRequest) Reset()
func (*CreateProjectRequest) String
func (x *CreateProjectRequest) String() string
CreateTagBindingMetadata
type CreateTagBindingMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for creating a TagValue.
func (*CreateTagBindingMetadata) Descriptor
func (*CreateTagBindingMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagBindingMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagBindingMetadata) ProtoMessage
func (*CreateTagBindingMetadata) ProtoMessage()
func (*CreateTagBindingMetadata) ProtoReflect
func (x *CreateTagBindingMetadata) ProtoReflect() protoreflect.Message
func (*CreateTagBindingMetadata) Reset
func (x *CreateTagBindingMetadata) Reset()
func (*CreateTagBindingMetadata) String
func (x *CreateTagBindingMetadata) String() string
CreateTagBindingRequest
type CreateTagBindingRequest struct {
// Required. The TagBinding to be created.
TagBinding *TagBinding `protobuf:"bytes,1,opt,name=tag_binding,json=tagBinding,proto3" json:"tag_binding,omitempty"`
// Optional. Set to true to perform the validations necessary for creating the resource,
// but not actually perform the action.
ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
The request message to create a TagBinding.
func (*CreateTagBindingRequest) Descriptor
func (*CreateTagBindingRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagBindingRequest.ProtoReflect.Descriptor instead.
func (*CreateTagBindingRequest) GetTagBinding
func (x *CreateTagBindingRequest) GetTagBinding() *TagBinding
func (*CreateTagBindingRequest) GetValidateOnly
func (x *CreateTagBindingRequest) GetValidateOnly() bool
func (*CreateTagBindingRequest) ProtoMessage
func (*CreateTagBindingRequest) ProtoMessage()
func (*CreateTagBindingRequest) ProtoReflect
func (x *CreateTagBindingRequest) ProtoReflect() protoreflect.Message
func (*CreateTagBindingRequest) Reset
func (x *CreateTagBindingRequest) Reset()
func (*CreateTagBindingRequest) String
func (x *CreateTagBindingRequest) String() string
CreateTagKeyMetadata
type CreateTagKeyMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for creating a TagKey.
func (*CreateTagKeyMetadata) Descriptor
func (*CreateTagKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagKeyMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagKeyMetadata) ProtoMessage
func (*CreateTagKeyMetadata) ProtoMessage()
func (*CreateTagKeyMetadata) ProtoReflect
func (x *CreateTagKeyMetadata) ProtoReflect() protoreflect.Message
func (*CreateTagKeyMetadata) Reset
func (x *CreateTagKeyMetadata) Reset()
func (*CreateTagKeyMetadata) String
func (x *CreateTagKeyMetadata) String() string
CreateTagKeyRequest
type CreateTagKeyRequest struct {
// Required. The TagKey to be created. Only fields `short_name`, `description`,
// and `parent` are considered during the creation request.
TagKey *TagKey `protobuf:"bytes,1,opt,name=tag_key,json=tagKey,proto3" json:"tag_key,omitempty"`
// Optional. Set to true to perform validations necessary for creating the resource, but
// not actually perform the action.
ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
The request message for creating a TagKey.
func (*CreateTagKeyRequest) Descriptor
func (*CreateTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagKeyRequest.ProtoReflect.Descriptor instead.
func (*CreateTagKeyRequest) GetTagKey
func (x *CreateTagKeyRequest) GetTagKey() *TagKey
func (*CreateTagKeyRequest) GetValidateOnly
func (x *CreateTagKeyRequest) GetValidateOnly() bool
func (*CreateTagKeyRequest) ProtoMessage
func (*CreateTagKeyRequest) ProtoMessage()
func (*CreateTagKeyRequest) ProtoReflect
func (x *CreateTagKeyRequest) ProtoReflect() protoreflect.Message
func (*CreateTagKeyRequest) Reset
func (x *CreateTagKeyRequest) Reset()
func (*CreateTagKeyRequest) String
func (x *CreateTagKeyRequest) String() string
CreateTagValueMetadata
type CreateTagValueMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for creating a TagValue.
func (*CreateTagValueMetadata) Descriptor
func (*CreateTagValueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagValueMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagValueMetadata) ProtoMessage
func (*CreateTagValueMetadata) ProtoMessage()
func (*CreateTagValueMetadata) ProtoReflect
func (x *CreateTagValueMetadata) ProtoReflect() protoreflect.Message
func (*CreateTagValueMetadata) Reset
func (x *CreateTagValueMetadata) Reset()
func (*CreateTagValueMetadata) String
func (x *CreateTagValueMetadata) String() string
CreateTagValueRequest
type CreateTagValueRequest struct {
// Required. The TagValue to be created. Only fields `short_name`, `description`,
// and `parent` are considered during the creation request.
TagValue *TagValue `protobuf:"bytes,1,opt,name=tag_value,json=tagValue,proto3" json:"tag_value,omitempty"`
// Optional. Set as true to perform the validations necessary for creating the resource,
// but not actually perform the action.
ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
The request message for creating a TagValue.
func (*CreateTagValueRequest) Descriptor
func (*CreateTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagValueRequest.ProtoReflect.Descriptor instead.
func (*CreateTagValueRequest) GetTagValue
func (x *CreateTagValueRequest) GetTagValue() *TagValue
func (*CreateTagValueRequest) GetValidateOnly
func (x *CreateTagValueRequest) GetValidateOnly() bool
func (*CreateTagValueRequest) ProtoMessage
func (*CreateTagValueRequest) ProtoMessage()
func (*CreateTagValueRequest) ProtoReflect
func (x *CreateTagValueRequest) ProtoReflect() protoreflect.Message
func (*CreateTagValueRequest) Reset
func (x *CreateTagValueRequest) Reset()
func (*CreateTagValueRequest) String
func (x *CreateTagValueRequest) String() string
DeleteFolderMetadata
type DeleteFolderMetadata struct {
// contains filtered or unexported fields
}
A status object which is used as the metadata
field for the Operation
returned by DeleteFolder
.
func (*DeleteFolderMetadata) Descriptor
func (*DeleteFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderMetadata.ProtoReflect.Descriptor instead.
func (*DeleteFolderMetadata) ProtoMessage
func (*DeleteFolderMetadata) ProtoMessage()
func (*DeleteFolderMetadata) ProtoReflect
func (x *DeleteFolderMetadata) ProtoReflect() protoreflect.Message
func (*DeleteFolderMetadata) Reset
func (x *DeleteFolderMetadata) Reset()
func (*DeleteFolderMetadata) String
func (x *DeleteFolderMetadata) String() string
DeleteFolderRequest
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"`
// contains filtered or unexported fields
}
The DeleteFolder request message.
func (*DeleteFolderRequest) Descriptor
func (*DeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderRequest.ProtoReflect.Descriptor instead.
func (*DeleteFolderRequest) GetName
func (x *DeleteFolderRequest) GetName() 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
DeleteOrganizationMetadata
type DeleteOrganizationMetadata struct {
// contains filtered or unexported fields
}
A status object which is used as the metadata
field for the operation
returned by DeleteOrganization.
func (*DeleteOrganizationMetadata) Descriptor
func (*DeleteOrganizationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteOrganizationMetadata.ProtoReflect.Descriptor instead.
func (*DeleteOrganizationMetadata) ProtoMessage
func (*DeleteOrganizationMetadata) ProtoMessage()
func (*DeleteOrganizationMetadata) ProtoReflect
func (x *DeleteOrganizationMetadata) ProtoReflect() protoreflect.Message
func (*DeleteOrganizationMetadata) Reset
func (x *DeleteOrganizationMetadata) Reset()
func (*DeleteOrganizationMetadata) String
func (x *DeleteOrganizationMetadata) String() string
DeleteProjectMetadata
type DeleteProjectMetadata struct {
// contains filtered or unexported fields
}
A status object which is used as the metadata
field for the Operation
returned by DeleteProject
.
func (*DeleteProjectMetadata) Descriptor
func (*DeleteProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectMetadata.ProtoReflect.Descriptor instead.
func (*DeleteProjectMetadata) ProtoMessage
func (*DeleteProjectMetadata) ProtoMessage()
func (*DeleteProjectMetadata) ProtoReflect
func (x *DeleteProjectMetadata) ProtoReflect() protoreflect.Message
func (*DeleteProjectMetadata) Reset
func (x *DeleteProjectMetadata) Reset()
func (*DeleteProjectMetadata) String
func (x *DeleteProjectMetadata) String() string
DeleteProjectRequest
type DeleteProjectRequest struct {
// Required. The name of the Project (for example, `projects/415104041262`).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
[DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject] method.
func (*DeleteProjectRequest) Descriptor
func (*DeleteProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectRequest.ProtoReflect.Descriptor instead.
func (*DeleteProjectRequest) GetName
func (x *DeleteProjectRequest) GetName() string
func (*DeleteProjectRequest) ProtoMessage
func (*DeleteProjectRequest) ProtoMessage()
func (*DeleteProjectRequest) ProtoReflect
func (x *DeleteProjectRequest) ProtoReflect() protoreflect.Message
func (*DeleteProjectRequest) Reset
func (x *DeleteProjectRequest) Reset()
func (*DeleteProjectRequest) String
func (x *DeleteProjectRequest) String() string
DeleteTagBindingMetadata
type DeleteTagBindingMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for deleting a TagBinding.
func (*DeleteTagBindingMetadata) Descriptor
func (*DeleteTagBindingMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagBindingMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagBindingMetadata) ProtoMessage
func (*DeleteTagBindingMetadata) ProtoMessage()
func (*DeleteTagBindingMetadata) ProtoReflect
func (x *DeleteTagBindingMetadata) ProtoReflect() protoreflect.Message
func (*DeleteTagBindingMetadata) Reset
func (x *DeleteTagBindingMetadata) Reset()
func (*DeleteTagBindingMetadata) String
func (x *DeleteTagBindingMetadata) String() string
DeleteTagBindingRequest
type DeleteTagBindingRequest struct {
// Required. The name of the TagBinding. This is a String of the form:
// `tagBindings/{id}` (e.g.
// `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The request message to delete a TagBinding.
func (*DeleteTagBindingRequest) Descriptor
func (*DeleteTagBindingRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagBindingRequest.ProtoReflect.Descriptor instead.
func (*DeleteTagBindingRequest) GetName
func (x *DeleteTagBindingRequest) GetName() string
func (*DeleteTagBindingRequest) ProtoMessage
func (*DeleteTagBindingRequest) ProtoMessage()
func (*DeleteTagBindingRequest) ProtoReflect
func (x *DeleteTagBindingRequest) ProtoReflect() protoreflect.Message
func (*DeleteTagBindingRequest) Reset
func (x *DeleteTagBindingRequest) Reset()
func (*DeleteTagBindingRequest) String
func (x *DeleteTagBindingRequest) String() string
DeleteTagKeyMetadata
type DeleteTagKeyMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for deleting a TagKey.
func (*DeleteTagKeyMetadata) Descriptor
func (*DeleteTagKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagKeyMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagKeyMetadata) ProtoMessage
func (*DeleteTagKeyMetadata) ProtoMessage()
func (*DeleteTagKeyMetadata) ProtoReflect
func (x *DeleteTagKeyMetadata) ProtoReflect() protoreflect.Message
func (*DeleteTagKeyMetadata) Reset
func (x *DeleteTagKeyMetadata) Reset()
func (*DeleteTagKeyMetadata) String
func (x *DeleteTagKeyMetadata) String() string
DeleteTagKeyRequest
type DeleteTagKeyRequest struct {
// Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`.
// The TagKey cannot be a parent of any existing TagValues or it will not be
// deleted successfully.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Set as true to perform validations necessary for deletion, but not actually
// perform the action.
ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// Optional. The etag known to the client for the expected state of the TagKey. This is
// to be used for optimistic concurrency.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
The request message for deleting a TagKey.
func (*DeleteTagKeyRequest) Descriptor
func (*DeleteTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagKeyRequest.ProtoReflect.Descriptor instead.
func (*DeleteTagKeyRequest) GetEtag
func (x *DeleteTagKeyRequest) GetEtag() string
func (*DeleteTagKeyRequest) GetName
func (x *DeleteTagKeyRequest) GetName() string
func (*DeleteTagKeyRequest) GetValidateOnly
func (x *DeleteTagKeyRequest) GetValidateOnly() bool
func (*DeleteTagKeyRequest) ProtoMessage
func (*DeleteTagKeyRequest) ProtoMessage()
func (*DeleteTagKeyRequest) ProtoReflect
func (x *DeleteTagKeyRequest) ProtoReflect() protoreflect.Message
func (*DeleteTagKeyRequest) Reset
func (x *DeleteTagKeyRequest) Reset()
func (*DeleteTagKeyRequest) String
func (x *DeleteTagKeyRequest) String() string
DeleteTagValueMetadata
type DeleteTagValueMetadata struct {
// contains filtered or unexported fields
}
Runtime operation information for deleting a TagValue.
func (*DeleteTagValueMetadata) Descriptor
func (*DeleteTagValueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagValueMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagValueMetadata) ProtoMessage
func (*DeleteTagValueMetadata) ProtoMessage()
func (*DeleteTagValueMetadata) ProtoReflect
func (x *DeleteTagValueMetadata) ProtoReflect() protoreflect.Message
func (*DeleteTagValueMetadata) Reset
func (x *DeleteTagValueMetadata) Reset()
func (*DeleteTagValueMetadata) String
func (x *DeleteTagValueMetadata) String() string
DeleteTagValueRequest
type DeleteTagValueRequest struct {
// Required. Resource name for TagValue to be deleted in the format tagValues/456.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Set as true to perform the validations necessary for deletion, but not
// actually perform the action.
ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// Optional. The etag known to the client for the expected state of the TagValue. This
// is to be used for optimistic concurrency.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
The request message for deleting a TagValue.
func (*DeleteTagValueRequest) Descriptor
func (*DeleteTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagValueRequest.ProtoReflect.Descriptor instead.
func (*DeleteTagValueRequest) GetEtag
func (x *DeleteTagValueRequest) GetEtag() string
func (*DeleteTagValueRequest) GetName
func (x *DeleteTagValueRequest) GetName() string
func (*DeleteTagValueRequest) GetValidateOnly
func (x *DeleteTagValueRequest) GetValidateOnly() bool
func (*DeleteTagValueRequest) ProtoMessage
func (*DeleteTagValueRequest) ProtoMessage()
func (*DeleteTagValueRequest) ProtoReflect
func (x *DeleteTagValueRequest) ProtoReflect() protoreflect.Message
func (*DeleteTagValueRequest) Reset
func (x *DeleteTagValueRequest) Reset()
func (*DeleteTagValueRequest) String
func (x *DeleteTagValueRequest) String() string
Folder
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 using
// [MoveFolder][google.cloud.resourcemanager.v3.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. For example,
// 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 state must be performed using
// [DeleteFolder][google.cloud.resourcemanager.v3.Folders.DeleteFolder] and
// [UndeleteFolder][google.cloud.resourcemanager.v3.Folders.UndeleteFolder].
State Folder_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.resourcemanager.v3.Folder_State" json:"state,omitempty"`
// Output only. Timestamp when the folder was created.
CreateTime *timestamp.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 *timestamp.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Timestamp when the folder was requested to be deleted.
DeleteTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. A checksum computed by the server based on the current value of the folder
// resource. This may be sent on update and delete requests to ensure the
// client has an up-to-date value before proceeding.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
A folder in an organization's resource hierarchy, used to organize that organization's resources.
func (*Folder) Descriptor
Deprecated: Use Folder.ProtoReflect.Descriptor instead.
func (*Folder) GetCreateTime
func (*Folder) GetDeleteTime
func (*Folder) GetDisplayName
func (*Folder) GetEtag
func (*Folder) GetName
func (*Folder) GetParent
func (*Folder) GetState
func (x *Folder) GetState() Folder_State
func (*Folder) GetUpdateTime
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
Folder_State
type Folder_State int32
Folder lifecycle states.
Folder_STATE_UNSPECIFIED, Folder_ACTIVE, Folder_DELETE_REQUESTED
const (
// Unspecified state.
Folder_STATE_UNSPECIFIED Folder_State = 0
// The normal and active state.
Folder_ACTIVE Folder_State = 1
// The folder has been marked for deletion by the user.
Folder_DELETE_REQUESTED Folder_State = 2
)
func (Folder_State) Descriptor
func (Folder_State) Descriptor() protoreflect.EnumDescriptor
func (Folder_State) Enum
func (x Folder_State) Enum() *Folder_State
func (Folder_State) EnumDescriptor
func (Folder_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Folder_State.Descriptor instead.
func (Folder_State) Number
func (x Folder_State) Number() protoreflect.EnumNumber
func (Folder_State) String
func (x Folder_State) String() string
func (Folder_State) Type
func (Folder_State) Type() protoreflect.EnumType
FoldersClient
type FoldersClient interface {
// 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)
// 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)
// 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 folders that
// share its parent.
// + The addition of the folder must not cause the active folder hierarchy
// to exceed a height of 10. Note, the full active + deleted folder hierarchy
// is allowed to reach a height of 20; 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 300.
//
// 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 in 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) (*longrunning.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 the naming constraints
// described in the [CreateFolder][google.cloud.resourcemanager.v3.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
// between 3 and 30 characters. This is captured by the regular expression:
// `[\p{L}\p{N}][\p{L}\p{N}_- ]{1,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) (*longrunning.Operation, 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 in the `Status.details` field.
// If it occurs asynchronously, then the FolderOperation will be returned
// in 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.v3.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) (*longrunning.Operation, error)
// Requests deletion of a folder. The folder is moved into the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state
// immediately, and is deleted approximately 30 days later. This method may
// only be called on an empty folder, where a folder is empty if it doesn't
// contain any folders or projects in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state.
// If called on a folder in [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED]
// state the operation will result in a no-op success.
// The caller must have `resourcemanager.folders.delete` permission on the
// identified folder.
DeleteFolder(ctx context.Context, in *DeleteFolderRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Cancels the deletion request for a folder. This method may be called on a
// folder in any state. If the folder is in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE]
// state the result will be a no-op success. In order to succeed, the folder's
// parent must be in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.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.v3.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.undelete` permission on the
// identified folder.
UndeleteFolder(ctx context.Context, in *UndeleteFolderRequest, opts ...grpc.CallOption) (*longrunning.Operation, 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, for example: "folders/1234".
// The caller must have `resourcemanager.folders.getIamPolicy` permission
// on the identified folder.
GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Sets the access control policy on a folder, replacing any existing policy.
// The `resource` field should be the folder's resource name, for example:
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Returns permissions that a caller has on the specified folder.
// The `resource` field should be the folder's resource name,
// for example: "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
}
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.
func NewFoldersClient
func NewFoldersClient(cc grpc.ClientConnInterface) FoldersClient
FoldersServer
type FoldersServer interface {
// 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)
// 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)
// 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 folders that
// share its parent.
// + The addition of the folder must not cause the active folder hierarchy
// to exceed a height of 10. Note, the full active + deleted folder hierarchy
// is allowed to reach a height of 20; 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 300.
//
// 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 in the details list in the `Operation.error`
// field.
//
// The caller must have `resourcemanager.folders.create` permission on the
// identified parent.
CreateFolder(context.Context, *CreateFolderRequest) (*longrunning.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 the naming constraints
// described in the [CreateFolder][google.cloud.resourcemanager.v3.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
// between 3 and 30 characters. This is captured by the regular expression:
// `[\p{L}\p{N}][\p{L}\p{N}_- ]{1,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) (*longrunning.Operation, 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 in the `Status.details` field.
// If it occurs asynchronously, then the FolderOperation will be returned
// in 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.v3.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.move` permission on the
// folder's current and proposed new parent.
MoveFolder(context.Context, *MoveFolderRequest) (*longrunning.Operation, error)
// Requests deletion of a folder. The folder is moved into the
// [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state
// immediately, and is deleted approximately 30 days later. This method may
// only be called on an empty folder, where a folder is empty if it doesn't
// contain any folders or projects in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE] state.
// If called on a folder in [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED]
// state the operation will result in a no-op success.
// The caller must have `resourcemanager.folders.delete` permission on the
// identified folder.
DeleteFolder(context.Context, *DeleteFolderRequest) (*longrunning.Operation, error)
// Cancels the deletion request for a folder. This method may be called on a
// folder in any state. If the folder is in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.ACTIVE]
// state the result will be a no-op success. In order to succeed, the folder's
// parent must be in the [ACTIVE][google.cloud.resourcemanager.v3.Folder.State.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.v3.Folders.CreateFolder] documentation.
// The caller must have `resourcemanager.folders.undelete` permission on the
// identified folder.
UndeleteFolder(context.Context, *UndeleteFolderRequest) (*longrunning.Operation, 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, for example: "folders/1234".
// The caller must have `resourcemanager.folders.getIamPolicy` permission
// on the identified folder.
GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
// Sets the access control policy on a folder, replacing any existing policy.
// The `resource` field should be the folder's resource name, for example:
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
// Returns permissions that a caller has on the specified folder.
// The `resource` field should be the folder's resource name,
// for example: "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
}
FoldersServer is the server API for Folders service.
GetFolderRequest
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
}
The GetFolder request message.
func (*GetFolderRequest) Descriptor
func (*GetFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFolderRequest.ProtoReflect.Descriptor instead.
func (*GetFolderRequest) GetName
func (x *GetFolderRequest) GetName() 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
GetOrganizationRequest
type GetOrganizationRequest struct {
// Required. The resource name of the Organization to fetch. This is the organization's
// relative path in the API, formatted as "organizations/[organizationId]".
// For example, "organizations/1234".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The request sent to the GetOrganization
method. The name
field is
required. organization_id
is no longer accepted.
func (*GetOrganizationRequest) Descriptor
func (*GetOrganizationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetOrganizationRequest.ProtoReflect.Descriptor instead.
func (*GetOrganizationRequest) GetName
func (x *GetOrganizationRequest) GetName() string
func (*GetOrganizationRequest) ProtoMessage
func (*GetOrganizationRequest) ProtoMessage()
func (*GetOrganizationRequest) ProtoReflect
func (x *GetOrganizationRequest) ProtoReflect() protoreflect.Message
func (*GetOrganizationRequest) Reset
func (x *GetOrganizationRequest) Reset()
func (*GetOrganizationRequest) String
func (x *GetOrganizationRequest) String() string
GetProjectRequest
type GetProjectRequest struct {
// Required. The name of the project (for example, `projects/415104041262`).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The request sent to the [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.
func (*GetProjectRequest) Descriptor
func (*GetProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.
func (*GetProjectRequest) GetName
func (x *GetProjectRequest) GetName() string
func (*GetProjectRequest) ProtoMessage
func (*GetProjectRequest) ProtoMessage()
func (*GetProjectRequest) ProtoReflect
func (x *GetProjectRequest) ProtoReflect() protoreflect.Message
func (*GetProjectRequest) Reset
func (x *GetProjectRequest) Reset()
func (*GetProjectRequest) String
func (x *GetProjectRequest) String() string
GetTagKeyRequest
type GetTagKeyRequest struct {
// Required. A resource name in the format `tagKeys/{id}`, such as
// `tagKeys/123`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The request message for getting a TagKey.
func (*GetTagKeyRequest) Descriptor
func (*GetTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTagKeyRequest.ProtoReflect.Descriptor instead.
func (*GetTagKeyRequest) GetName
func (x *GetTagKeyRequest) GetName() string
func (*GetTagKeyRequest) ProtoMessage
func (*GetTagKeyRequest) ProtoMessage()
func (*GetTagKeyRequest) ProtoReflect
func (x *GetTagKeyRequest) ProtoReflect() protoreflect.Message
func (*GetTagKeyRequest) Reset
func (x *GetTagKeyRequest) Reset()
func (*GetTagKeyRequest) String
func (x *GetTagKeyRequest) String() string
GetTagValueRequest
type GetTagValueRequest struct {
// Required. Resource name for TagValue to be fetched in the format `tagValues/456`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The request message for getting a TagValue.
func (*GetTagValueRequest) Descriptor
func (*GetTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTagValueRequest.ProtoReflect.Descriptor instead.
func (*GetTagValueRequest) GetName
func (x *GetTagValueRequest) GetName() string
func (*GetTagValueRequest) ProtoMessage
func (*GetTagValueRequest) ProtoMessage()
func (*GetTagValueRequest) ProtoReflect
func (x *GetTagValueRequest) ProtoReflect() protoreflect.Message
func (*GetTagValueRequest) Reset
func (x *GetTagValueRequest) Reset()
func (*GetTagValueRequest) String
func (x *GetTagValueRequest) String() string
ListFoldersRequest
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.
// If unspecified, server picks an appropriate default.
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.v3.Folder.State.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
}
The ListFolders request message.
func (*ListFoldersRequest) Descriptor
func (*ListFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersRequest.ProtoReflect.Descriptor instead.
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) GetShowDeleted
func (x *ListFoldersRequest) GetShowDeleted() bool
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
ListFoldersResponse
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
}
The ListFolders response message.
func (*ListFoldersResponse) Descriptor
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
ListProjectsRequest
type ListProjectsRequest struct {
// Required. The name of the parent resource to list projects under.
//
// For example, setting this field to 'folders/1234' would list all projects
// directly under that folder.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. A pagination token returned from a previous call to [ListProjects]
// [google.cloud.resourcemanager.v3.Projects.ListProjects]
// that indicates from where listing should continue.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. The maximum number of projects to return in the response.
// The server can return fewer projects than requested.
// If unspecified, server picks an appropriate default.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be
// returned. Normally only `ACTIVE` projects are returned.
ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
// contains filtered or unexported fields
}
The request sent to the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.
func (*ListProjectsRequest) Descriptor
func (*ListProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsRequest.ProtoReflect.Descriptor instead.
func (*ListProjectsRequest) GetPageSize
func (x *ListProjectsRequest) GetPageSize() int32
func (*ListProjectsRequest) GetPageToken
func (x *ListProjectsRequest) GetPageToken() string
func (*ListProjectsRequest) GetParent
func (x *ListProjectsRequest) GetParent() string
func (*ListProjectsRequest) GetShowDeleted
func (x *ListProjectsRequest) GetShowDeleted() bool
func (*ListProjectsRequest) ProtoMessage
func (*ListProjectsRequest) ProtoMessage()
func (*ListProjectsRequest) ProtoReflect
func (x *ListProjectsRequest) ProtoReflect() protoreflect.Message
func (*ListProjectsRequest) Reset
func (x *ListProjectsRequest) Reset()
func (*ListProjectsRequest) String
func (x *ListProjectsRequest) String() string
ListProjectsResponse
type ListProjectsResponse struct {
// The list of Projects under the parent. This list can be paginated.
Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
// Pagination token.
//
// If the result set is too large to fit in a single response, this token
// is returned. It encodes the position of the current result cursor.
// Feeding this value into a new list request with the `page_token` parameter
// gives the next page of the results.
//
// When `next_page_token` is not filled in, there is no next page and
// the list returned is the last page in the result set.
//
// Pagination tokens have a limited lifetime.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
A page of the response received from the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.
A paginated response where more pages are available has
next_page_token
set. This token can be used in a subsequent request to
retrieve the next request page.
NOTE: A response may contain fewer elements than the request page_size
and
still have a next_page_token
.
func (*ListProjectsResponse) Descriptor
func (*ListProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsResponse.ProtoReflect.Descriptor instead.
func (*ListProjectsResponse) GetNextPageToken
func (x *ListProjectsResponse) GetNextPageToken() string
func (*ListProjectsResponse) GetProjects
func (x *ListProjectsResponse) GetProjects() []*Project
func (*ListProjectsResponse) ProtoMessage
func (*ListProjectsResponse) ProtoMessage()
func (*ListProjectsResponse) ProtoReflect
func (x *ListProjectsResponse) ProtoReflect() protoreflect.Message
func (*ListProjectsResponse) Reset
func (x *ListProjectsResponse) Reset()
func (*ListProjectsResponse) String
func (x *ListProjectsResponse) String() string
ListTagBindingsRequest
type ListTagBindingsRequest struct {
// Required. The full resource name of a resource for which you want to list existing
// TagBindings.
// E.g. "//cloudresourcemanager.googleapis.com/projects/123"
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of TagBindings to return in the response. The server
// allows a maximum of 300 TagBindings to return. If unspecified, the server
// will use 100 as the default.
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 `ListTagBindings`
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The request message to list all TagBindings for a parent.
func (*ListTagBindingsRequest) Descriptor
func (*ListTagBindingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagBindingsRequest.ProtoReflect.Descriptor instead.
func (*ListTagBindingsRequest) GetPageSize
func (x *ListTagBindingsRequest) GetPageSize() int32
func (*ListTagBindingsRequest) GetPageToken
func (x *ListTagBindingsRequest) GetPageToken() string
func (*ListTagBindingsRequest) GetParent
func (x *ListTagBindingsRequest) GetParent() string
func (*ListTagBindingsRequest) ProtoMessage
func (*ListTagBindingsRequest) ProtoMessage()
func (*ListTagBindingsRequest) ProtoReflect
func (x *ListTagBindingsRequest) ProtoReflect() protoreflect.Message
func (*ListTagBindingsRequest) Reset
func (x *ListTagBindingsRequest) Reset()
func (*ListTagBindingsRequest) String
func (x *ListTagBindingsRequest) String() string
ListTagBindingsResponse
type ListTagBindingsResponse struct {
// A possibly paginated list of TagBindings for the specified TagValue or
// resource.
TagBindings []*TagBinding `protobuf:"bytes,1,rep,name=tag_bindings,json=tagBindings,proto3" json:"tag_bindings,omitempty"`
// Pagination token.
//
// If the result set is too large to fit in a single response, this token
// is returned. It encodes the position of the current result cursor.
// Feeding this value into a new list request with the `page_token` parameter
// gives the next page of the results.
//
// When `next_page_token` is not filled in, there is no next page and
// the list returned is the last page in the result set.
//
// Pagination tokens have a limited lifetime.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The ListTagBindings response.
func (*ListTagBindingsResponse) Descriptor
func (*ListTagBindingsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagBindingsResponse.ProtoReflect.Descriptor instead.
func (*ListTagBindingsResponse) GetNextPageToken
func (x *ListTagBindingsResponse) GetNextPageToken() string
func (*ListTagBindingsResponse) GetTagBindings
func (x *ListTagBindingsResponse) GetTagBindings() []*TagBinding
func (*ListTagBindingsResponse) ProtoMessage
func (*ListTagBindingsResponse) ProtoMessage()
func (*ListTagBindingsResponse) ProtoReflect
func (x *ListTagBindingsResponse) ProtoReflect() protoreflect.Message
func (*ListTagBindingsResponse) Reset
func (x *ListTagBindingsResponse) Reset()
func (*ListTagBindingsResponse) String
func (x *ListTagBindingsResponse) String() string
ListTagKeysRequest
type ListTagKeysRequest struct {
// Required. The resource name of the new TagKey'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"`
// Optional. The maximum number of TagKeys to return in the response. The server allows
// a maximum of 300 TagKeys to return. If unspecified, the server will use 100
// as the default.
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 `ListTagKey`
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The request message for listing all TagKeys under a parent resource.
func (*ListTagKeysRequest) Descriptor
func (*ListTagKeysRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagKeysRequest.ProtoReflect.Descriptor instead.
func (*ListTagKeysRequest) GetPageSize
func (x *ListTagKeysRequest) GetPageSize() int32
func (*ListTagKeysRequest) GetPageToken
func (x *ListTagKeysRequest) GetPageToken() string
func (*ListTagKeysRequest) GetParent
func (x *ListTagKeysRequest) GetParent() string
func (*ListTagKeysRequest) ProtoMessage
func (*ListTagKeysRequest) ProtoMessage()
func (*ListTagKeysRequest) ProtoReflect
func (x *ListTagKeysRequest) ProtoReflect() protoreflect.Message
func (*ListTagKeysRequest) Reset
func (x *ListTagKeysRequest) Reset()
func (*ListTagKeysRequest) String
func (x *ListTagKeysRequest) String() string
ListTagKeysResponse
type ListTagKeysResponse struct {
// List of TagKeys that live under the specified parent in the request.
TagKeys []*TagKey `protobuf:"bytes,1,rep,name=tag_keys,json=tagKeys,proto3" json:"tag_keys,omitempty"`
// A pagination token returned from a previous call to `ListTagKeys`
// 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
}
The ListTagKeys response message.
func (*ListTagKeysResponse) Descriptor
func (*ListTagKeysResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagKeysResponse.ProtoReflect.Descriptor instead.
func (*ListTagKeysResponse) GetNextPageToken
func (x *ListTagKeysResponse) GetNextPageToken() string
func (*ListTagKeysResponse) GetTagKeys
func (x *ListTagKeysResponse) GetTagKeys() []*TagKey
func (*ListTagKeysResponse) ProtoMessage
func (*ListTagKeysResponse) ProtoMessage()
func (*ListTagKeysResponse) ProtoReflect
func (x *ListTagKeysResponse) ProtoReflect() protoreflect.Message
func (*ListTagKeysResponse) Reset
func (x *ListTagKeysResponse) Reset()
func (*ListTagKeysResponse) String
func (x *ListTagKeysResponse) String() string
ListTagValuesRequest
type ListTagValuesRequest struct {
// Required. Resource name for TagKey, parent of the TagValues to be listed,
// in the format `tagKeys/123`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of TagValues to return in the response. The server
// allows a maximum of 300 TagValues to return. If unspecified, the server
// will use 100 as the default.
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 `ListTagValues`
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
The request message for listing TagValues for the specified TagKey.
func (*ListTagValuesRequest) Descriptor
func (*ListTagValuesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagValuesRequest.ProtoReflect.Descriptor instead.
func (*ListTagValuesRequest) GetPageSize
func (x *ListTagValuesRequest) GetPageSize() int32
func (*ListTagValuesRequest) GetPageToken
func (x *ListTagValuesRequest) GetPageToken() string
func (*ListTagValuesRequest) GetParent
func (x *ListTagValuesRequest) GetParent() string
func (*ListTagValuesRequest) ProtoMessage
func (*ListTagValuesRequest) ProtoMessage()
func (*ListTagValuesRequest) ProtoReflect
func (x *ListTagValuesRequest) ProtoReflect() protoreflect.Message
func (*ListTagValuesRequest) Reset
func (x *ListTagValuesRequest) Reset()
func (*ListTagValuesRequest) String
func (x *ListTagValuesRequest) String() string
ListTagValuesResponse
type ListTagValuesResponse struct {
// A possibly paginated list of TagValues that are direct descendants of
// the specified parent TagKey.
TagValues []*TagValue `protobuf:"bytes,1,rep,name=tag_values,json=tagValues,proto3" json:"tag_values,omitempty"`
// A pagination token returned from a previous call to `ListTagValues`
// that indicates from where listing should continue. This is currently not
// used, but the server may at any point start supplying a valid token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
The ListTagValues response.
func (*ListTagValuesResponse) Descriptor
func (*ListTagValuesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagValuesResponse.ProtoReflect.Descriptor instead.
func (*ListTagValuesResponse) GetNextPageToken
func (x *ListTagValuesResponse) GetNextPageToken() string
func (*ListTagValuesResponse) GetTagValues
func (x *ListTagValuesResponse) GetTagValues() []*TagValue
func (*ListTagValuesResponse) ProtoMessage
func (*ListTagValuesResponse) ProtoMessage()
func (*ListTagValuesResponse) ProtoReflect
func (x *ListTagValuesResponse) ProtoReflect() protoreflect.Message
func (*ListTagValuesResponse) Reset
func (x *ListTagValuesResponse) Reset()
func (*ListTagValuesResponse) String
func (x *ListTagValuesResponse) String() string
MoveFolderMetadata
type MoveFolderMetadata struct {
// The display name of the folder.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The resource name of the folder's parent.
SourceParent string `protobuf:"bytes,2,opt,name=source_parent,json=sourceParent,proto3" json:"source_parent,omitempty"`
// The resource name of the folder or organization to move the folder to.
DestinationParent string `protobuf:"bytes,3,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
// contains filtered or unexported fields
}
Metadata pertaining to the folder move process.
func (*MoveFolderMetadata) Descriptor
func (*MoveFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use MoveFolderMetadata.ProtoReflect.Descriptor instead.
func (*MoveFolderMetadata) GetDestinationParent
func (x *MoveFolderMetadata) GetDestinationParent() string
func (*MoveFolderMetadata) GetDisplayName
func (x *MoveFolderMetadata) GetDisplayName() string
func (*MoveFolderMetadata) GetSourceParent
func (x *MoveFolderMetadata) GetSourceParent() string
func (*MoveFolderMetadata) ProtoMessage
func (*MoveFolderMetadata) ProtoMessage()
func (*MoveFolderMetadata) ProtoReflect
func (x *MoveFolderMetadata) ProtoReflect() protoreflect.Message
func (*MoveFolderMetadata) Reset
func (x *MoveFolderMetadata) Reset()
func (*MoveFolderMetadata) String
func (x *MoveFolderMetadata) String() string
MoveFolderRequest
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 which should be the
// folder's new parent.
// 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
}
The MoveFolder request message.
func (*MoveFolderRequest) Descriptor
func (*MoveFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveFolderRequest.ProtoReflect.Descriptor instead.
func (*MoveFolderRequest) GetDestinationParent
func (x *MoveFolderRequest) GetDestinationParent() string
func (*MoveFolderRequest) GetName
func (x *MoveFolderRequest) GetName() string
func (*MoveFolderRequest) ProtoMessage
func (*MoveFolderRequest) ProtoMessage()
func (*MoveFolderRequest) ProtoReflect
func (x *MoveFolderRequest) ProtoReflect() protoreflect.Message
func (*MoveFolderRequest) Reset
func (x *MoveFolderRequest) Reset()
func (*MoveFolderRequest) String
func (x *MoveFolderRequest) String() string
MoveProjectMetadata
type MoveProjectMetadata struct {
// contains filtered or unexported fields
}
A status object which is used as the metadata
field for the Operation
returned by MoveProject.
func (*MoveProjectMetadata) Descriptor
func (*MoveProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use MoveProjectMetadata.ProtoReflect.Descriptor instead.
func (*MoveProjectMetadata) ProtoMessage
func (*MoveProjectMetadata) ProtoMessage()
func (*MoveProjectMetadata) ProtoReflect
func (x *MoveProjectMetadata) ProtoReflect() protoreflect.Message
func (*MoveProjectMetadata) Reset
func (x *MoveProjectMetadata) Reset()
func (*MoveProjectMetadata) String
func (x *MoveProjectMetadata) String() string
MoveProjectRequest
type MoveProjectRequest struct {
// Required. The name of the project to move.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The new parent to move the Project under.
DestinationParent string `protobuf:"bytes,2,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
// contains filtered or unexported fields
}
The request sent to [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method.
func (*MoveProjectRequest) Descriptor
func (*MoveProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveProjectRequest.ProtoReflect.Descriptor instead.
func (*MoveProjectRequest) GetDestinationParent
func (x *MoveProjectRequest) GetDestinationParent() string
func (*MoveProjectRequest) GetName
func (x *MoveProjectRequest) GetName() string
func (*MoveProjectRequest) ProtoMessage
func (*MoveProjectRequest) ProtoMessage()
func (*MoveProjectRequest) ProtoReflect
func (x *MoveProjectRequest) ProtoReflect() protoreflect.Message
func (*MoveProjectRequest) Reset
func (x *MoveProjectRequest) Reset()
func (*MoveProjectRequest) String
func (x *MoveProjectRequest) String() string
Organization
type Organization struct {
// Output only. The resource name of the organization. This is the
// organization's relative path in the API. Its format is
// "organizations/[organization_id]". For example, "organizations/1234".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. A human-readable string that refers to the organization in the
// Google Cloud Console. This string is set by the server and cannot be
// changed. The string will be set to the primary domain (for example,
// "google.com") of the Google Workspace customer that owns the organization.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The owner of this organization. The owner should be specified on
// creation. Once set, it cannot be changed.
//
// The lifetime of the organization and all of its descendants are bound to
// the owner. If the owner is deleted, the organization and all its
// descendants will be deleted.
//
// Types that are assignable to Owner:
//
// *Organization_DirectoryCustomerId
Owner isOrganization_Owner `protobuf_oneof:"owner"`
// Output only. The organization's current lifecycle state.
State Organization_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.resourcemanager.v3.Organization_State" json:"state,omitempty"`
// Output only. Timestamp when the Organization was created.
CreateTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the Organization was last modified.
UpdateTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Timestamp when the Organization was requested for deletion.
DeleteTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. A checksum computed by the server based on the current value of the
// Organization resource. This may be sent on update and delete requests to
// ensure the client has an up-to-date value before proceeding.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.
func (*Organization) Descriptor
func (*Organization) Descriptor() ([]byte, []int)
Deprecated: Use Organization.ProtoReflect.Descriptor instead.
func (*Organization) GetCreateTime
func (x *Organization) GetCreateTime() *timestamp.Timestamp
func (*Organization) GetDeleteTime
func (x *Organization) GetDeleteTime() *timestamp.Timestamp
func (*Organization) GetDirectoryCustomerId
func (x *Organization) GetDirectoryCustomerId() string
func (*Organization) GetDisplayName
func (x *Organization) GetDisplayName() string
func (*Organization) GetEtag
func (x *Organization) GetEtag() string
func (*Organization) GetName
func (x *Organization) GetName() string
func (*Organization) GetOwner
func (m *Organization) GetOwner() isOrganization_Owner
func (*Organization) GetState
func (x *Organization) GetState() Organization_State
func (*Organization) GetUpdateTime
func (x *Organization) GetUpdateTime() *timestamp.Timestamp
func (*Organization) ProtoMessage
func (*Organization) ProtoMessage()
func (*Organization) ProtoReflect
func (x *Organization) ProtoReflect() protoreflect.Message
func (*Organization) Reset
func (x *Organization) Reset()
func (*Organization) String
func (x *Organization) String() string
Organization_DirectoryCustomerId
type Organization_DirectoryCustomerId struct {
// Immutable. The G Suite / Workspace customer id used in the Directory API.
DirectoryCustomerId string `protobuf:"bytes,3,opt,name=directory_customer_id,json=directoryCustomerId,proto3,oneof"`
}
Organization_State
type Organization_State int32
Organization lifecycle states.
Organization_STATE_UNSPECIFIED, Organization_ACTIVE, Organization_DELETE_REQUESTED
const (
// Unspecified state. This is only useful for distinguishing unset values.
Organization_STATE_UNSPECIFIED Organization_State = 0
// The normal and active state.
Organization_ACTIVE Organization_State = 1
// The organization has been marked for deletion by the user.
Organization_DELETE_REQUESTED Organization_State = 2
)
func (Organization_State) Descriptor
func (Organization_State) Descriptor() protoreflect.EnumDescriptor
func (Organization_State) Enum
func (x Organization_State) Enum() *Organization_State
func (Organization_State) EnumDescriptor
func (Organization_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Organization_State.Descriptor instead.
func (Organization_State) Number
func (x Organization_State) Number() protoreflect.EnumNumber
func (Organization_State) String
func (x Organization_State) String() string
func (Organization_State) Type
func (Organization_State) Type() protoreflect.EnumType
OrganizationsClient
type OrganizationsClient interface {
// Fetches an organization resource identified by the specified resource name.
GetOrganization(ctx context.Context, in *GetOrganizationRequest, opts ...grpc.CallOption) (*Organization, error)
// Searches organization resources that are visible to the user and satisfy
// the specified filter. This method returns organizations in an unspecified
// order. New organizations do not necessarily appear at the end of the
// results, and may take a small amount of time to appear.
//
// Search will only return organizations on which the user has the permission
// `resourcemanager.organizations.get`
SearchOrganizations(ctx context.Context, in *SearchOrganizationsRequest, opts ...grpc.CallOption) (*SearchOrganizationsResponse, error)
// Gets the access control policy for an organization resource. The policy may
// be empty if no such policy or resource exists. The `resource` field should
// be the organization's resource name, for example: "organizations/123".
//
// Authorization requires the IAM permission
// `resourcemanager.organizations.getIamPolicy` on the specified organization.
GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Sets the access control policy on an organization resource. Replaces any
// existing policy. The `resource` field should be the organization's resource
// name, for example: "organizations/123".
//
// Authorization requires the IAM permission
// `resourcemanager.organizations.setIamPolicy` on the specified organization.
SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Returns the permissions that a caller has on the specified organization.
// The `resource` field should be the organization's resource name,
// for example: "organizations/123".
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
}
OrganizationsClient is the client API for Organizations service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewOrganizationsClient
func NewOrganizationsClient(cc grpc.ClientConnInterface) OrganizationsClient
OrganizationsServer
type OrganizationsServer interface {
// Fetches an organization resource identified by the specified resource name.
GetOrganization(context.Context, *GetOrganizationRequest) (*Organization, error)
// Searches organization resources that are visible to the user and satisfy
// the specified filter. This method returns organizations in an unspecified
// order. New organizations do not necessarily appear at the end of the
// results, and may take a small amount of time to appear.
//
// Search will only return organizations on which the user has the permission
// `resourcemanager.organizations.get`
SearchOrganizations(context.Context, *SearchOrganizationsRequest) (*SearchOrganizationsResponse, error)
// Gets the access control policy for an organization resource. The policy may
// be empty if no such policy or resource exists. The `resource` field should
// be the organization's resource name, for example: "organizations/123".
//
// Authorization requires the IAM permission
// `resourcemanager.organizations.getIamPolicy` on the specified organization.
GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
// Sets the access control policy on an organization resource. Replaces any
// existing policy. The `resource` field should be the organization's resource
// name, for example: "organizations/123".
//
// Authorization requires the IAM permission
// `resourcemanager.organizations.setIamPolicy` on the specified organization.
SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
// Returns the permissions that a caller has on the specified organization.
// The `resource` field should be the organization's resource name,
// for example: "organizations/123".
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
}
OrganizationsServer is the server API for Organizations service.
Project
type Project struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
State Project_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.resourcemanager.v3.Project_State" json:"state,omitempty"`
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
CreateTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
DeleteTime *timestamp.Timestamp `protobuf:"bytes,8,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
Labels map[string]string "" /* 154 byte string literal not displayed */
}
A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.
func (*Project) Descriptor
Deprecated: Use Project.ProtoReflect.Descriptor instead.
func (*Project) GetCreateTime
func (*Project) GetDeleteTime
func (*Project) GetDisplayName
func (*Project) GetEtag
func (*Project) GetLabels
func (*Project) GetName
func (*Project) GetParent
func (*Project) GetProjectId
func (*Project) GetState
func (x *Project) GetState() Project_State
func (*Project) GetUpdateTime
func (*Project) ProtoMessage
func (*Project) ProtoMessage()
func (*Project) ProtoReflect
func (x *Project) ProtoReflect() protoreflect.Message
func (*Project) Reset
func (x *Project) Reset()
func (*Project) String
Project_State
type Project_State int32
Project lifecycle states.
Project_STATE_UNSPECIFIED, Project_ACTIVE, Project_DELETE_REQUESTED
const (
// Unspecified state. This is only used/useful for distinguishing
// unset values.
Project_STATE_UNSPECIFIED Project_State = 0
// The normal and active state.
Project_ACTIVE Project_State = 1
// The project has been marked for deletion by the user
// (by invoking
// [DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject])
// or by the system (Google Cloud Platform).
// This can generally be reversed by invoking [UndeleteProject]
// [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
Project_DELETE_REQUESTED Project_State = 2
)
func (Project_State) Descriptor
func (Project_State) Descriptor() protoreflect.EnumDescriptor
func (Project_State) Enum
func (x Project_State) Enum() *Project_State
func (Project_State) EnumDescriptor
func (Project_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Project_State.Descriptor instead.
func (Project_State) Number
func (x Project_State) Number() protoreflect.EnumNumber
func (Project_State) String
func (x Project_State) String() string
func (Project_State) Type
func (Project_State) Type() protoreflect.EnumType
ProjectsClient
type ProjectsClient interface {
// Retrieves the project identified by the specified `name` (for example,
// `projects/415104041262`).
//
// The caller must have `resourcemanager.projects.get` permission
// for this project.
GetProject(ctx context.Context, in *GetProjectRequest, opts ...grpc.CallOption) (*Project, error)
// Lists projects that are direct children of the specified folder or
// organization resource. `list()` provides a strongly consistent view of the
// projects underneath the specified parent resource. `list()` returns
// projects sorted based upon the (ascending) lexical ordering of their
// `display_name`. The caller must have `resourcemanager.projects.list`
// permission on the identified parent.
ListProjects(ctx context.Context, in *ListProjectsRequest, opts ...grpc.CallOption) (*ListProjectsResponse, error)
// Search for projects that the caller has both `resourcemanager.projects.get`
// permission on, and also satisfy the specified query.
//
// This method returns projects in an unspecified order.
//
// This method is eventually consistent with project mutations; this means
// that a newly created project may not appear in the results or recent
// updates to an existing project may not be reflected in the results. To
// retrieve the latest state of a project, use the
// [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.
SearchProjects(ctx context.Context, in *SearchProjectsRequest, opts ...grpc.CallOption) (*SearchProjectsResponse, error)
// Request that a new project be created. The result is an `Operation` which
// can be used to track the creation process. This process usually takes a few
// seconds, but can sometimes take much longer. The tracking `Operation` is
// automatically deleted after a few hours, so there is no need to call
// `DeleteOperation`.
CreateProject(ctx context.Context, in *CreateProjectRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Updates the `display_name` and labels of the project identified by the
// specified `name` (for example, `projects/415104041262`). Deleting all
// labels requires an update mask for labels field.
//
// The caller must have `resourcemanager.projects.update` permission for this
// project.
UpdateProject(ctx context.Context, in *UpdateProjectRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Move a project to another place in your resource hierarchy, under a new
// resource parent.
//
// Returns an operation which can be used to track the process of the project
// move workflow.
// Upon success, the `Operation.response` field will be populated with the
// moved project.
//
// The caller must have `resourcemanager.projects.update` permission on the
// project and have `resourcemanager.projects.move` permission on the
// project's current and proposed new parent.
MoveProject(ctx context.Context, in *MoveProjectRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Marks the project identified by the specified
// `name` (for example, `projects/415104041262`) for deletion.
//
// This method will only affect the project if it has a lifecycle state of
// [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE].
//
// This method changes the Project's lifecycle state from
// [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE]
// to [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Project.State.DELETE_REQUESTED].
// The deletion starts at an unspecified time,
// at which point the Project is no longer accessible.
//
// Until the deletion completes, you can check the lifecycle state
// checked by retrieving the project with [GetProject]
// [google.cloud.resourcemanager.v3.Projects.GetProject],
// and the project remains visible to [ListProjects]
// [google.cloud.resourcemanager.v3.Projects.ListProjects].
// However, you cannot update the project.
//
// After the deletion completes, the project is not retrievable by
// the [GetProject]
// [google.cloud.resourcemanager.v3.Projects.GetProject],
// [ListProjects]
// [google.cloud.resourcemanager.v3.Projects.ListProjects], and
// [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects]
// methods.
//
// This method behaves idempotently, such that deleting a `DELETE_REQUESTED`
// project will not cause an error, but also won't do anything.
//
// The caller must have `resourcemanager.projects.delete` permissions for this
// project.
DeleteProject(ctx context.Context, in *DeleteProjectRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Restores the project identified by the specified
// `name` (for example, `projects/415104041262`).
// You can only use this method for a project that has a lifecycle state of
// [DELETE_REQUESTED]
// [Projects.State.DELETE_REQUESTED].
// After deletion starts, the project cannot be restored.
//
// The caller must have `resourcemanager.projects.undelete` permission for
// this project.
UndeleteProject(ctx context.Context, in *UndeleteProjectRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Returns the IAM access control policy for the specified project.
// Permission is denied if the policy or the resource do not exist.
GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Sets the IAM access control policy for the specified project.
//
// CAUTION: This method will replace the existing policy, and cannot be used
// to append additional IAM settings.
//
// Note: Removing service accounts from policies or changing their roles can
// render services completely inoperable. It is important to understand how
// the service account is being used before removing or updating its roles.
//
// The following constraints apply when using `setIamPolicy()`:
//
// + Project does not support `allUsers` and `allAuthenticatedUsers` as
// `members` in a `Binding` of a `Policy`.
//
// + The owner role can be granted to a `user`, `serviceAccount`, or a group
// that is part of an organization. For example,
// group@myownpersonaldomain.com could be added as an owner to a project in
// the myownpersonaldomain.com organization, but not the examplepetstore.com
// organization.
//
// + Service accounts can be made owners of a project directly
// without any restrictions. However, to be added as an owner, a user must be
// invited using the Cloud Platform console and must accept the invitation.
//
// + A user cannot be granted the owner role using `setIamPolicy()`. The user
// must be granted the owner role using the Cloud Platform Console and must
// explicitly accept the invitation.
//
// + Invitations to grant the owner role cannot be sent using
// `setIamPolicy()`;
// they must be sent only using the Cloud Platform Console.
//
// + Membership changes that leave the project without any owners that have
// accepted the Terms of Service (ToS) will be rejected.
//
// + If the project is not part of an organization, there must be at least
// one owner who has accepted the Terms of Service (ToS) agreement in the
// policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner
// from the policy will fail. This restriction also applies to legacy
// projects that no longer have owners who have accepted the ToS. Edits to
// IAM policies will be rejected until the lack of a ToS-accepting owner is
// rectified.
//
// + Calling this method requires enabling the App Engine Admin API.
SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Returns permissions that a caller has on the specified project.
TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
}
ProjectsClient is the client API for Projects service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewProjectsClient
func NewProjectsClient(cc grpc.ClientConnInterface) ProjectsClient
ProjectsServer
type ProjectsServer interface {
// Retrieves the project identified by the specified `name` (for example,
// `projects/415104041262`).
//
// The caller must have `resourcemanager.projects.get` permission
// for this project.
GetProject(context.Context, *GetProjectRequest) (*Project, error)
// Lists projects that are direct children of the specified folder or
// organization resource. `list()` provides a strongly consistent view of the
// projects underneath the specified parent resource. `list()` returns
// projects sorted based upon the (ascending) lexical ordering of their
// `display_name`. The caller must have `resourcemanager.projects.list`
// permission on the identified parent.
ListProjects(context.Context, *ListProjectsRequest) (*ListProjectsResponse, error)
// Search for projects that the caller has both `resourcemanager.projects.get`
// permission on, and also satisfy the specified query.
//
// This method returns projects in an unspecified order.
//
// This method is eventually consistent with project mutations; this means
// that a newly created project may not appear in the results or recent
// updates to an existing project may not be reflected in the results. To
// retrieve the latest state of a project, use the
// [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.
SearchProjects(context.Context, *SearchProjectsRequest) (*SearchProjectsResponse, error)
// Request that a new project be created. The result is an `Operation` which
// can be used to track the creation process. This process usually takes a few
// seconds, but can sometimes take much longer. The tracking `Operation` is
// automatically deleted after a few hours, so there is no need to call
// `DeleteOperation`.
CreateProject(context.Context, *CreateProjectRequest) (*longrunning.Operation, error)
// Updates the `display_name` and labels of the project identified by the
// specified `name` (for example, `projects/415104041262`). Deleting all
// labels requires an update mask for labels field.
//
// The caller must have `resourcemanager.projects.update` permission for this
// project.
UpdateProject(context.Context, *UpdateProjectRequest) (*longrunning.Operation, error)
// Move a project to another place in your resource hierarchy, under a new
// resource parent.
//
// Returns an operation which can be used to track the process of the project
// move workflow.
// Upon success, the `Operation.response` field will be populated with the
// moved project.
//
// The caller must have `resourcemanager.projects.update` permission on the
// project and have `resourcemanager.projects.move` permission on the
// project's current and proposed new parent.
MoveProject(context.Context, *MoveProjectRequest) (*longrunning.Operation, error)
// Marks the project identified by the specified
// `name` (for example, `projects/415104041262`) for deletion.
//
// This method will only affect the project if it has a lifecycle state of
// [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE].
//
// This method changes the Project's lifecycle state from
// [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE]
// to [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Project.State.DELETE_REQUESTED].
// The deletion starts at an unspecified time,
// at which point the Project is no longer accessible.
//
// Until the deletion completes, you can check the lifecycle state
// checked by retrieving the project with [GetProject]
// [google.cloud.resourcemanager.v3.Projects.GetProject],
// and the project remains visible to [ListProjects]
// [google.cloud.resourcemanager.v3.Projects.ListProjects].
// However, you cannot update the project.
//
// After the deletion completes, the project is not retrievable by
// the [GetProject]
// [google.cloud.resourcemanager.v3.Projects.GetProject],
// [ListProjects]
// [google.cloud.resourcemanager.v3.Projects.ListProjects], and
// [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects]
// methods.
//
// This method behaves idempotently, such that deleting a `DELETE_REQUESTED`
// project will not cause an error, but also won't do anything.
//
// The caller must have `resourcemanager.projects.delete` permissions for this
// project.
DeleteProject(context.Context, *DeleteProjectRequest) (*longrunning.Operation, error)
// Restores the project identified by the specified
// `name` (for example, `projects/415104041262`).
// You can only use this method for a project that has a lifecycle state of
// [DELETE_REQUESTED]
// [Projects.State.DELETE_REQUESTED].
// After deletion starts, the project cannot be restored.
//
// The caller must have `resourcemanager.projects.undelete` permission for
// this project.
UndeleteProject(context.Context, *UndeleteProjectRequest) (*longrunning.Operation, error)
// Returns the IAM access control policy for the specified project.
// Permission is denied if the policy or the resource do not exist.
GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
// Sets the IAM access control policy for the specified project.
//
// CAUTION: This method will replace the existing policy, and cannot be used
// to append additional IAM settings.
//
// Note: Removing service accounts from policies or changing their roles can
// render services completely inoperable. It is important to understand how
// the service account is being used before removing or updating its roles.
//
// The following constraints apply when using `setIamPolicy()`:
//
// + Project does not support `allUsers` and `allAuthenticatedUsers` as
// `members` in a `Binding` of a `Policy`.
//
// + The owner role can be granted to a `user`, `serviceAccount`, or a group
// that is part of an organization. For example,
// group@myownpersonaldomain.com could be added as an owner to a project in
// the myownpersonaldomain.com organization, but not the examplepetstore.com
// organization.
//
// + Service accounts can be made owners of a project directly
// without any restrictions. However, to be added as an owner, a user must be
// invited using the Cloud Platform console and must accept the invitation.
//
// + A user cannot be granted the owner role using `setIamPolicy()`. The user
// must be granted the owner role using the Cloud Platform Console and must
// explicitly accept the invitation.
//
// + Invitations to grant the owner role cannot be sent using
// `setIamPolicy()`;
// they must be sent only using the Cloud Platform Console.
//
// + Membership changes that leave the project without any owners that have
// accepted the Terms of Service (ToS) will be rejected.
//
// + If the project is not part of an organization, there must be at least
// one owner who has accepted the Terms of Service (ToS) agreement in the
// policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner
// from the policy will fail. This restriction also applies to legacy
// projects that no longer have owners who have accepted the ToS. Edits to
// IAM policies will be rejected until the lack of a ToS-accepting owner is
// rectified.
//
// + Calling this method requires enabling the App Engine Admin API.
SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
// Returns permissions that a caller has on the specified project.
TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
}
ProjectsServer is the server API for Projects service.
SearchFoldersRequest
type SearchFoldersRequest struct {
// Optional. The maximum number of folders to return in the response.
// If unspecified, server picks an appropriate default.
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"`
// Optional. 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,
// state 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.
//
// ```
// | Field | Description |
// |-------------------------|----------------------------------------|
// | displayName | Filters by displayName. |
// | parent | Filters by parent (for example: folders/123). |
// | state, lifecycleState | Filters by state. |
// ```
//
// Some example queries are:
//
// * Query `displayName=Test*` returns Folder resources whose display name
// starts with "Test".
// * Query `state=ACTIVE` returns Folder resources with
// `state` set to `ACTIVE`.
// * Query `parent=folders/123` returns Folder resources that have
// `folders/123` as a parent resource.
// * Query `parent=folders/123 AND state=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
}
The request message for searching folders.
func (*SearchFoldersRequest) Descriptor
func (*SearchFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersRequest.ProtoReflect.Descriptor instead.
func (*SearchFoldersRequest) GetPageSize
func (x *SearchFoldersRequest) GetPageSize() int32
func (*SearchFoldersRequest) GetPageToken
func (x *SearchFoldersRequest) GetPageToken() string
func (*SearchFoldersRequest) GetQuery
func (x *SearchFoldersRequest) GetQuery() string
func (*SearchFoldersRequest) ProtoMessage
func (*SearchFoldersRequest) ProtoMessage()
func (*SearchFoldersRequest) ProtoReflect
func (x *SearchFoldersRequest) ProtoReflect() protoreflect.Message
func (*SearchFoldersRequest) Reset
func (x *SearchFoldersRequest) Reset()
func (*SearchFoldersRequest) String
func (x *SearchFoldersRequest) String() string
SearchFoldersResponse
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
}
The response message for searching folders.
func (*SearchFoldersResponse) Descriptor
func (*SearchFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersResponse.ProtoReflect.Descriptor instead.
func (*SearchFoldersResponse) GetFolders
func (x *SearchFoldersResponse) GetFolders() []*Folder
func (*SearchFoldersResponse) GetNextPageToken
func (x *SearchFoldersResponse) GetNextPageToken() string
func (*SearchFoldersResponse) ProtoMessage
func (*SearchFoldersResponse) ProtoMessage()
func (*SearchFoldersResponse) ProtoReflect
func (x *SearchFoldersResponse) ProtoReflect() protoreflect.Message
func (*SearchFoldersResponse) Reset
func (x *SearchFoldersResponse) Reset()
func (*SearchFoldersResponse) String
func (x *SearchFoldersResponse) String() string
SearchOrganizationsRequest
type SearchOrganizationsRequest struct {
// Optional. The maximum number of organizations to return in the response.
// If unspecified, server picks an appropriate default.
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 `SearchOrganizations`
// that indicates from where listing should continue.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. An optional query string used to filter the Organizations to return in
// the response. Query rules are case-insensitive.
//
// ```
// | Field | Description |
// |------------------|--------------------------------------------|
// | directoryCustomerId, owner.directoryCustomerId | Filters by directory
// customer id. |
// | domain | Filters by domain. |
// ```
//
// Organizations may be queried by `directoryCustomerId` or by
// `domain`, where the domain is a G Suite domain, for example:
//
// * Query `directorycustomerid:123456789` returns Organization
// resources with `owner.directory_customer_id` equal to `123456789`.
// * Query `domain:google.com` returns Organization resources corresponding
// to the domain `google.com`.
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
// contains filtered or unexported fields
}
The request sent to the SearchOrganizations
method.
func (*SearchOrganizationsRequest) Descriptor
func (*SearchOrganizationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchOrganizationsRequest.ProtoReflect.Descriptor instead.
func (*SearchOrganizationsRequest) GetPageSize
func (x *SearchOrganizationsRequest) GetPageSize() int32
func (*SearchOrganizationsRequest) GetPageToken
func (x *SearchOrganizationsRequest) GetPageToken() string
func (*SearchOrganizationsRequest) GetQuery
func (x *SearchOrganizationsRequest) GetQuery() string
func (*SearchOrganizationsRequest) ProtoMessage
func (*SearchOrganizationsRequest) ProtoMessage()
func (*SearchOrganizationsRequest) ProtoReflect
func (x *SearchOrganizationsRequest) ProtoReflect() protoreflect.Message
func (*SearchOrganizationsRequest) Reset
func (x *SearchOrganizationsRequest) Reset()
func (*SearchOrganizationsRequest) String
func (x *SearchOrganizationsRequest) String() string
SearchOrganizationsResponse
type SearchOrganizationsResponse struct {
// The list of Organizations that matched the search query, possibly
// paginated.
Organizations []*Organization `protobuf:"bytes,1,rep,name=organizations,proto3" json:"organizations,omitempty"`
// A pagination token to be used to retrieve the next page of results. If the
// result is too large to fit within the page size specified in the request,
// this field will be set with a token that can be used to fetch the next page
// of results. If this field is empty, it indicates that this response
// contains the last 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
}
The response returned from the SearchOrganizations
method.
func (*SearchOrganizationsResponse) Descriptor
func (*SearchOrganizationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchOrganizationsResponse.ProtoReflect.Descriptor instead.
func (*SearchOrganizationsResponse) GetNextPageToken
func (x *SearchOrganizationsResponse) GetNextPageToken() string
func (*SearchOrganizationsResponse) GetOrganizations
func (x *SearchOrganizationsResponse) GetOrganizations() []*Organization
func (*SearchOrganizationsResponse) ProtoMessage
func (*SearchOrganizationsResponse) ProtoMessage()
func (*SearchOrganizationsResponse) ProtoReflect
func (x *SearchOrganizationsResponse) ProtoReflect() protoreflect.Message
func (*SearchOrganizationsResponse) Reset
func (x *SearchOrganizationsResponse) Reset()
func (*SearchOrganizationsResponse) String
func (x *SearchOrganizationsResponse) String() string
SearchProjectsRequest
type SearchProjectsRequest struct {
// Optional. A query string for searching for projects that the caller has
// `resourcemanager.projects.get` permission to. If multiple fields are
// included in the query, the it will return results that match any of the
// fields. Some eligible fields are:
//
// ```
// | Field | Description |
// |-------------------------|----------------------------------------------|
// | displayName, name | Filters by displayName. |
// | parent | Project's parent. (for example: folders/123,
// organizations/*) Prefer parent field over parent.type and parent.id. |
// | parent.type | Parent's type: `folder` or `organization`. |
// | parent.id | Parent's id number (for example: 123) |
// | id, projectId | Filters by projectId. |
// | state, lifecycleState | Filters by state. |
// | labels | Filters by label name or value. |
// | labels.
The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.
func (*SearchProjectsRequest) Descriptor
func (*SearchProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsRequest.ProtoReflect.Descriptor instead.
func (*SearchProjectsRequest) GetPageSize
func (x *SearchProjectsRequest) GetPageSize() int32
func (*SearchProjectsRequest) GetPageToken
func (x *SearchProjectsRequest) GetPageToken() string
func (*SearchProjectsRequest) GetQuery
func (x *SearchProjectsRequest) GetQuery() string
func (*SearchProjectsRequest) ProtoMessage
func (*SearchProjectsRequest) ProtoMessage()
func (*SearchProjectsRequest) ProtoReflect
func (x *SearchProjectsRequest) ProtoReflect() protoreflect.Message
func (*SearchProjectsRequest) Reset
func (x *SearchProjectsRequest) Reset()
func (*SearchProjectsRequest) String
func (x *SearchProjectsRequest) String() string
SearchProjectsResponse
type SearchProjectsResponse struct {
// The list of Projects that matched the list filter query. This list can
// be paginated.
Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
// Pagination token.
//
// If the result set is too large to fit in a single response, this token
// is returned. It encodes the position of the current result cursor.
// Feeding this value into a new list request with the `page_token` parameter
// gives the next page of the results.
//
// When `next_page_token` is not filled in, there is no next page and
// the list returned is the last page in the result set.
//
// Pagination tokens have a limited lifetime.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
A page of the response received from the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.
A paginated response where more pages are available has
next_page_token
set. This token can be used in a subsequent request to
retrieve the next request page.
func (*SearchProjectsResponse) Descriptor
func (*SearchProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsResponse.ProtoReflect.Descriptor instead.
func (*SearchProjectsResponse) GetNextPageToken
func (x *SearchProjectsResponse) GetNextPageToken() string
func (*SearchProjectsResponse) GetProjects
func (x *SearchProjectsResponse) GetProjects() []*Project
func (*SearchProjectsResponse) ProtoMessage
func (*SearchProjectsResponse) ProtoMessage()
func (*SearchProjectsResponse) ProtoReflect
func (x *SearchProjectsResponse) ProtoReflect() protoreflect.Message
func (*SearchProjectsResponse) Reset
func (x *SearchProjectsResponse) Reset()
func (*SearchProjectsResponse) String
func (x *SearchProjectsResponse) String() string
TagBinding
type TagBinding struct {
// Output only. The name of the TagBinding. This is a String of the form:
// `tagBindings/{full-resource-name}/{tag-value-name}` (e.g.
// `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The full resource name of the resource the TagValue is bound to.
// E.g. `//cloudresourcemanager.googleapis.com/projects/123`
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// The TagValue of the TagBinding.
// Must be of the form `tagValues/456`.
TagValue string `protobuf:"bytes,3,opt,name=tag_value,json=tagValue,proto3" json:"tag_value,omitempty"`
// contains filtered or unexported fields
}
A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.
func (*TagBinding) Descriptor
func (*TagBinding) Descriptor() ([]byte, []int)
Deprecated: Use TagBinding.ProtoReflect.Descriptor instead.
func (*TagBinding) GetName
func (x *TagBinding) GetName() string
func (*TagBinding) GetParent
func (x *TagBinding) GetParent() string
func (*TagBinding) GetTagValue
func (x *TagBinding) GetTagValue() string
func (*TagBinding) ProtoMessage
func (*TagBinding) ProtoMessage()
func (*TagBinding) ProtoReflect
func (x *TagBinding) ProtoReflect() protoreflect.Message
func (*TagBinding) Reset
func (x *TagBinding) Reset()
func (*TagBinding) String
func (x *TagBinding) String() string
TagBindingsClient
type TagBindingsClient interface {
// Lists the TagBindings for the given cloud resource, as specified with
// `parent`.
//
// NOTE: The `parent` field is expected to be a full resource name:
// https://cloud.google.com/apis/design/resource_names#full_resource_name
ListTagBindings(ctx context.Context, in *ListTagBindingsRequest, opts ...grpc.CallOption) (*ListTagBindingsResponse, error)
// Creates a TagBinding between a TagValue and a cloud resource
// (currently project, folder, or organization).
CreateTagBinding(ctx context.Context, in *CreateTagBindingRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Deletes a TagBinding.
DeleteTagBinding(ctx context.Context, in *DeleteTagBindingRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}
TagBindingsClient is the client API for TagBindings service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewTagBindingsClient
func NewTagBindingsClient(cc grpc.ClientConnInterface) TagBindingsClient
TagBindingsServer
type TagBindingsServer interface {
// Lists the TagBindings for the given cloud resource, as specified with
// `parent`.
//
// NOTE: The `parent` field is expected to be a full resource name:
// https://cloud.google.com/apis/design/resource_names#full_resource_name
ListTagBindings(context.Context, *ListTagBindingsRequest) (*ListTagBindingsResponse, error)
// Creates a TagBinding between a TagValue and a cloud resource
// (currently project, folder, or organization).
CreateTagBinding(context.Context, *CreateTagBindingRequest) (*longrunning.Operation, error)
// Deletes a TagBinding.
DeleteTagBinding(context.Context, *DeleteTagBindingRequest) (*longrunning.Operation, error)
}
TagBindingsServer is the server API for TagBindings service.
TagKey
type TagKey struct {
// Immutable. The resource name for a TagKey. Must be in the format
// `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for
// the TagKey.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The resource name of the new TagKey's parent.
// Must be of the form `organizations/{org_id}`.
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Immutable. The user friendly name for a TagKey. The short name should be
// unique for TagKeys within the same tag namespace.
//
// The short name must be 1-63 characters, beginning and ending with
// an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
// dots (.), and alphanumerics between.
ShortName string `protobuf:"bytes,3,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
// Output only. Immutable. Namespaced name of the TagKey.
NamespacedName string `protobuf:"bytes,4,opt,name=namespaced_name,json=namespacedName,proto3" json:"namespaced_name,omitempty"`
// Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
//
// Read-write.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Creation time.
CreateTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Update time.
UpdateTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. Entity tag which users can pass to prevent race conditions. This field is
// always set in server responses. See UpdateTagKeyRequest for details.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
A TagKey, used to group a set of TagValues.
func (*TagKey) Descriptor
Deprecated: Use TagKey.ProtoReflect.Descriptor instead.