Enum value maps for Folder_State.
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 Organization_State.
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 Project_State.
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 Purpose.
var (
Purpose_name = map[int32]string{
0: "PURPOSE_UNSPECIFIED",
1: "GCE_FIREWALL",
}
Purpose_value = map[string]int32{
"PURPOSE_UNSPECIFIED": 0,
"GCE_FIREWALL": 1,
}
)
var File_google_cloud_resourcemanager_v3_folders_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_organizations_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_projects_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_tag_bindings_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_tag_holds_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_tag_keys_proto protoreflect.FileDescriptor
var File_google_cloud_resourcemanager_v3_tag_values_proto protoreflect.FileDescriptor
func RegisterFoldersServer(s *grpc.Server, srv FoldersServer)
func RegisterOrganizationsServer(s *grpc.Server, srv OrganizationsServer)
func RegisterProjectsServer(s *grpc.Server, srv ProjectsServer)
func RegisterTagBindingsServer(s *grpc.Server, srv TagBindingsServer)
func RegisterTagHoldsServer(s *grpc.Server, srv TagHoldsServer)
func RegisterTagKeysServer(s *grpc.Server, srv TagKeysServer)
func RegisterTagValuesServer(s *grpc.Server, srv TagValuesServer)
Metadata pertaining to the Folder creation process.
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
}
func (*CreateFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateFolderMetadata.ProtoReflect.Descriptor instead.
func (x *CreateFolderMetadata) GetDisplayName() string
func (x *CreateFolderMetadata) GetParent() string
func (*CreateFolderMetadata) ProtoMessage()
func (x *CreateFolderMetadata) ProtoReflect() protoreflect.Message
func (x *CreateFolderMetadata) Reset()
func (x *CreateFolderMetadata) String() string
The CreateFolder request message.
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
}
func (*CreateFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFolderRequest.ProtoReflect.Descriptor instead.
func (x *CreateFolderRequest) GetFolder() *Folder
func (*CreateFolderRequest) ProtoMessage()
func (x *CreateFolderRequest) ProtoReflect() protoreflect.Message
func (x *CreateFolderRequest) Reset()
func (x *CreateFolderRequest) String() string
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.
type CreateProjectMetadata struct {
// Creation time of the project creation workflow.
CreateTime *timestamppb.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
}
func (*CreateProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectMetadata.ProtoReflect.Descriptor instead.
func (x *CreateProjectMetadata) GetCreateTime() *timestamppb.Timestamp
func (x *CreateProjectMetadata) GetGettable() bool
func (x *CreateProjectMetadata) GetReady() bool
func (*CreateProjectMetadata) ProtoMessage()
func (x *CreateProjectMetadata) ProtoReflect() protoreflect.Message
func (x *CreateProjectMetadata) Reset()
func (x *CreateProjectMetadata) String() string
The request sent to the [CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject] method.
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 Organization, 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
}
func (*CreateProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectRequest.ProtoReflect.Descriptor instead.
func (x *CreateProjectRequest) GetProject() *Project
func (*CreateProjectRequest) ProtoMessage()
func (x *CreateProjectRequest) ProtoReflect() protoreflect.Message
func (x *CreateProjectRequest) Reset()
func (x *CreateProjectRequest) String() string
Runtime operation information for creating a TagValue.
type CreateTagBindingMetadata struct {
// contains filtered or unexported fields
}
func (*CreateTagBindingMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagBindingMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagBindingMetadata) ProtoMessage()
func (x *CreateTagBindingMetadata) ProtoReflect() protoreflect.Message
func (x *CreateTagBindingMetadata) Reset()
func (x *CreateTagBindingMetadata) String() string
The request message to create a TagBinding.
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
}
func (*CreateTagBindingRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagBindingRequest.ProtoReflect.Descriptor instead.
func (x *CreateTagBindingRequest) GetTagBinding() *TagBinding
func (x *CreateTagBindingRequest) GetValidateOnly() bool
func (*CreateTagBindingRequest) ProtoMessage()
func (x *CreateTagBindingRequest) ProtoReflect() protoreflect.Message
func (x *CreateTagBindingRequest) Reset()
func (x *CreateTagBindingRequest) String() string
Runtime operation information for creating a TagHold. (-- The metadata is currently empty, but may include information in the future. --)
type CreateTagHoldMetadata struct {
// contains filtered or unexported fields
}
func (*CreateTagHoldMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagHoldMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagHoldMetadata) ProtoMessage()
func (x *CreateTagHoldMetadata) ProtoReflect() protoreflect.Message
func (x *CreateTagHoldMetadata) Reset()
func (x *CreateTagHoldMetadata) String() string
The request message to create a TagHold.
type CreateTagHoldRequest struct {
// Required. The resource name of the TagHold's parent TagValue. Must be of
// the form: `tagValues/{tag-value-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The TagHold to be created.
TagHold *TagHold `protobuf:"bytes,2,opt,name=tag_hold,json=tagHold,proto3" json:"tag_hold,omitempty"`
// Optional. Set to true to perform the validations necessary for creating the
// resource, but not actually perform the action.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTagHoldRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagHoldRequest.ProtoReflect.Descriptor instead.
func (x *CreateTagHoldRequest) GetParent() string
func (x *CreateTagHoldRequest) GetTagHold() *TagHold
func (x *CreateTagHoldRequest) GetValidateOnly() bool
func (*CreateTagHoldRequest) ProtoMessage()
func (x *CreateTagHoldRequest) ProtoReflect() protoreflect.Message
func (x *CreateTagHoldRequest) Reset()
func (x *CreateTagHoldRequest) String() string
Runtime operation information for creating a TagKey.
type CreateTagKeyMetadata struct {
// contains filtered or unexported fields
}
func (*CreateTagKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagKeyMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagKeyMetadata) ProtoMessage()
func (x *CreateTagKeyMetadata) ProtoReflect() protoreflect.Message
func (x *CreateTagKeyMetadata) Reset()
func (x *CreateTagKeyMetadata) String() string
The request message for creating a TagKey.
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
}
func (*CreateTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagKeyRequest.ProtoReflect.Descriptor instead.
func (x *CreateTagKeyRequest) GetTagKey() *TagKey
func (x *CreateTagKeyRequest) GetValidateOnly() bool
func (*CreateTagKeyRequest) ProtoMessage()
func (x *CreateTagKeyRequest) ProtoReflect() protoreflect.Message
func (x *CreateTagKeyRequest) Reset()
func (x *CreateTagKeyRequest) String() string
Runtime operation information for creating a TagValue.
type CreateTagValueMetadata struct {
// contains filtered or unexported fields
}
func (*CreateTagValueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagValueMetadata.ProtoReflect.Descriptor instead.
func (*CreateTagValueMetadata) ProtoMessage()
func (x *CreateTagValueMetadata) ProtoReflect() protoreflect.Message
func (x *CreateTagValueMetadata) Reset()
func (x *CreateTagValueMetadata) String() string
The request message for creating a TagValue.
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
}
func (*CreateTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTagValueRequest.ProtoReflect.Descriptor instead.
func (x *CreateTagValueRequest) GetTagValue() *TagValue
func (x *CreateTagValueRequest) GetValidateOnly() bool
func (*CreateTagValueRequest) ProtoMessage()
func (x *CreateTagValueRequest) ProtoReflect() protoreflect.Message
func (x *CreateTagValueRequest) Reset()
func (x *CreateTagValueRequest) String() string
A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.
type DeleteFolderMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderMetadata.ProtoReflect.Descriptor instead.
func (*DeleteFolderMetadata) ProtoMessage()
func (x *DeleteFolderMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteFolderMetadata) Reset()
func (x *DeleteFolderMetadata) String() string
The DeleteFolder request message.
type DeleteFolderRequest struct {
// Required. The resource name of the folder to be deleted.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFolderRequest.ProtoReflect.Descriptor instead.
func (x *DeleteFolderRequest) GetName() string
func (*DeleteFolderRequest) ProtoMessage()
func (x *DeleteFolderRequest) ProtoReflect() protoreflect.Message
func (x *DeleteFolderRequest) Reset()
func (x *DeleteFolderRequest) String() string
A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.
type DeleteOrganizationMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteOrganizationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteOrganizationMetadata.ProtoReflect.Descriptor instead.
func (*DeleteOrganizationMetadata) ProtoMessage()
func (x *DeleteOrganizationMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteOrganizationMetadata) Reset()
func (x *DeleteOrganizationMetadata) String() string
A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.
type DeleteProjectMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectMetadata.ProtoReflect.Descriptor instead.
func (*DeleteProjectMetadata) ProtoMessage()
func (x *DeleteProjectMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteProjectMetadata) Reset()
func (x *DeleteProjectMetadata) String() string
[DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject] method.
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
}
func (*DeleteProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectRequest.ProtoReflect.Descriptor instead.
func (x *DeleteProjectRequest) GetName() string
func (*DeleteProjectRequest) ProtoMessage()
func (x *DeleteProjectRequest) ProtoReflect() protoreflect.Message
func (x *DeleteProjectRequest) Reset()
func (x *DeleteProjectRequest) String() string
Runtime operation information for deleting a TagBinding.
type DeleteTagBindingMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteTagBindingMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagBindingMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagBindingMetadata) ProtoMessage()
func (x *DeleteTagBindingMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteTagBindingMetadata) Reset()
func (x *DeleteTagBindingMetadata) String() string
The request message to delete a TagBinding.
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
}
func (*DeleteTagBindingRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagBindingRequest.ProtoReflect.Descriptor instead.
func (x *DeleteTagBindingRequest) GetName() string
func (*DeleteTagBindingRequest) ProtoMessage()
func (x *DeleteTagBindingRequest) ProtoReflect() protoreflect.Message
func (x *DeleteTagBindingRequest) Reset()
func (x *DeleteTagBindingRequest) String() string
Runtime operation information for deleting a TagHold. (-- The metadata is currently empty, but may include information in the future. --)
type DeleteTagHoldMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteTagHoldMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagHoldMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagHoldMetadata) ProtoMessage()
func (x *DeleteTagHoldMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteTagHoldMetadata) Reset()
func (x *DeleteTagHoldMetadata) String() string
The request message to delete a TagHold.
type DeleteTagHoldRequest struct {
// Required. The resource name of the TagHold to delete. Must be of the form:
// `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Set to true to perform the validations necessary for deleting 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
}
func (*DeleteTagHoldRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagHoldRequest.ProtoReflect.Descriptor instead.
func (x *DeleteTagHoldRequest) GetName() string
func (x *DeleteTagHoldRequest) GetValidateOnly() bool
func (*DeleteTagHoldRequest) ProtoMessage()
func (x *DeleteTagHoldRequest) ProtoReflect() protoreflect.Message
func (x *DeleteTagHoldRequest) Reset()
func (x *DeleteTagHoldRequest) String() string
Runtime operation information for deleting a TagKey.
type DeleteTagKeyMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteTagKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagKeyMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagKeyMetadata) ProtoMessage()
func (x *DeleteTagKeyMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteTagKeyMetadata) Reset()
func (x *DeleteTagKeyMetadata) String() string
The request message for deleting a TagKey.
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
}
func (*DeleteTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagKeyRequest.ProtoReflect.Descriptor instead.
func (x *DeleteTagKeyRequest) GetEtag() string
func (x *DeleteTagKeyRequest) GetName() string
func (x *DeleteTagKeyRequest) GetValidateOnly() bool
func (*DeleteTagKeyRequest) ProtoMessage()
func (x *DeleteTagKeyRequest) ProtoReflect() protoreflect.Message
func (x *DeleteTagKeyRequest) Reset()
func (x *DeleteTagKeyRequest) String() string
Runtime operation information for deleting a TagValue.
type DeleteTagValueMetadata struct {
// contains filtered or unexported fields
}
func (*DeleteTagValueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagValueMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTagValueMetadata) ProtoMessage()
func (x *DeleteTagValueMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteTagValueMetadata) Reset()
func (x *DeleteTagValueMetadata) String() string
The request message for deleting a TagValue.
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
}
func (*DeleteTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTagValueRequest.ProtoReflect.Descriptor instead.
func (x *DeleteTagValueRequest) GetEtag() string
func (x *DeleteTagValueRequest) GetName() string
func (x *DeleteTagValueRequest) GetValidateOnly() bool
func (*DeleteTagValueRequest) ProtoMessage()
func (x *DeleteTagValueRequest) ProtoReflect() protoreflect.Message
func (x *DeleteTagValueRequest) Reset()
func (x *DeleteTagValueRequest) String() string
An EffectiveTag represents a tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. EffectiveTag contains the name and namespaced_name of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.
type EffectiveTag struct {
// Resource name for TagValue in the format `tagValues/456`.
TagValue string `protobuf:"bytes,1,opt,name=tag_value,json=tagValue,proto3" json:"tag_value,omitempty"`
// The namespaced name of the TagValue. Can be in the form
// `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
// `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
// `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
NamespacedTagValue string `protobuf:"bytes,2,opt,name=namespaced_tag_value,json=namespacedTagValue,proto3" json:"namespaced_tag_value,omitempty"`
// The name of the TagKey, in the format `tagKeys/{id}`, such as
// `tagKeys/123`.
TagKey string `protobuf:"bytes,3,opt,name=tag_key,json=tagKey,proto3" json:"tag_key,omitempty"`
// The namespaced name of the TagKey. Can be in the form
// `{organization_id}/{tag_key_short_name}` or
// `{project_id}/{tag_key_short_name}` or
// `{project_number}/{tag_key_short_name}`.
NamespacedTagKey string `protobuf:"bytes,4,opt,name=namespaced_tag_key,json=namespacedTagKey,proto3" json:"namespaced_tag_key,omitempty"`
// The parent name of the tag key.
// Must be in the format `organizations/{organization_id}` or
// `projects/{project_number}`
TagKeyParentName string `protobuf:"bytes,6,opt,name=tag_key_parent_name,json=tagKeyParentName,proto3" json:"tag_key_parent_name,omitempty"`
// Indicates the inheritance status of a tag value
// attached to the given resource. If the tag value is inherited from one of
// the resource's ancestors, inherited will be true. If false, then the tag
// value is directly attached to the resource, inherited will be false.
Inherited bool `protobuf:"varint,5,opt,name=inherited,proto3" json:"inherited,omitempty"`
// contains filtered or unexported fields
}
func (*EffectiveTag) Descriptor() ([]byte, []int)
Deprecated: Use EffectiveTag.ProtoReflect.Descriptor instead.
func (x *EffectiveTag) GetInherited() bool
func (x *EffectiveTag) GetNamespacedTagKey() string
func (x *EffectiveTag) GetNamespacedTagValue() string
func (x *EffectiveTag) GetTagKey() string
func (x *EffectiveTag) GetTagKeyParentName() string
func (x *EffectiveTag) GetTagValue() string
func (*EffectiveTag) ProtoMessage()
func (x *EffectiveTag) ProtoReflect() protoreflect.Message
func (x *EffectiveTag) Reset()
func (x *EffectiveTag) String() string
A folder in an organization's resource hierarchy, used to organize that organization's resources.
type Folder struct {
// Output only. The resource name of the folder.
// Its format is `folders/{folder_id}`, for example: "folders/1234".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The folder's parent's resource name.
// Updates to the folder's parent must be performed 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 *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the folder was last modified.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Timestamp when the folder was requested to be deleted.
DeleteTime *timestamppb.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
}
func (*Folder) Descriptor() ([]byte, []int)
Deprecated: Use Folder.ProtoReflect.Descriptor instead.
func (x *Folder) GetCreateTime() *timestamppb.Timestamp
func (x *Folder) GetDeleteTime() *timestamppb.Timestamp
func (x *Folder) GetDisplayName() string
func (x *Folder) GetEtag() string
func (x *Folder) GetName() string
func (x *Folder) GetParent() string
func (x *Folder) GetState() Folder_State
func (x *Folder) GetUpdateTime() *timestamppb.Timestamp
func (*Folder) ProtoMessage()
func (x *Folder) ProtoReflect() protoreflect.Message
func (x *Folder) Reset()
func (x *Folder) String() string
Folder lifecycle states.
type Folder_State int32
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() protoreflect.EnumDescriptor
func (x Folder_State) Enum() *Folder_State
func (Folder_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Folder_State.Descriptor instead.
func (x Folder_State) Number() protoreflect.EnumNumber
func (x Folder_State) String() string
func (Folder_State) Type() protoreflect.EnumType
FoldersClient is the client API for Folders service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type FoldersClient interface {
// 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) (*longrunningpb.Operation, error)
// Updates a folder, changing its `display_name`.
// Changes to the folder `display_name` will be rejected if they violate
// either the `display_name` formatting rules or 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) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.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 *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on a folder, replacing any existing policy.
// The `resource` field should be the folder's resource name, for example:
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified folder.
// The `resource` field should be the folder's resource name,
// for example: "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewFoldersClient(cc grpc.ClientConnInterface) FoldersClient
FoldersServer is the server API for Folders service.
type FoldersServer interface {
// 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) (*longrunningpb.Operation, error)
// Updates a folder, changing its `display_name`.
// Changes to the folder `display_name` will be rejected if they violate
// either the `display_name` formatting rules or 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) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.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, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on a folder, replacing any existing policy.
// The `resource` field should be the folder's resource name, for example:
// "folders/1234".
// The caller must have `resourcemanager.folders.setIamPolicy` permission
// on the identified folder.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified folder.
// The `resource` field should be the folder's resource name,
// for example: "folders/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
The GetFolder request message.
type GetFolderRequest struct {
// Required. The resource name of the folder to retrieve.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFolderRequest.ProtoReflect.Descriptor instead.
func (x *GetFolderRequest) GetName() string
func (*GetFolderRequest) ProtoMessage()
func (x *GetFolderRequest) ProtoReflect() protoreflect.Message
func (x *GetFolderRequest) Reset()
func (x *GetFolderRequest) String() string
The request message for getting a TagKey by its namespaced name.
type GetNamespacedTagKeyRequest struct {
// Required. A namespaced tag key name in the format
// `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name
// "foo" under the organization with ID 42 or `r2-d2/bar` for a key with short
// name "bar" under the project `r2-d2`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNamespacedTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNamespacedTagKeyRequest.ProtoReflect.Descriptor instead.
func (x *GetNamespacedTagKeyRequest) GetName() string
func (*GetNamespacedTagKeyRequest) ProtoMessage()
func (x *GetNamespacedTagKeyRequest) ProtoReflect() protoreflect.Message
func (x *GetNamespacedTagKeyRequest) Reset()
func (x *GetNamespacedTagKeyRequest) String() string
The request message for getting a TagValue by its namespaced name.
type GetNamespacedTagValueRequest struct {
// Required. A namespaced tag value name in the following format:
//
// `{parentId}/{tagKeyShort}/{tagValueShort}`
//
// Examples:
// - `42/foo/abc` for a value with short name "abc" under the key with short
// name "foo" under the organization with ID 42
// - `r2-d2/bar/xyz` for a value with short name "xyz" under the key with
// short name "bar" under the project with ID "r2-d2"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNamespacedTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNamespacedTagValueRequest.ProtoReflect.Descriptor instead.
func (x *GetNamespacedTagValueRequest) GetName() string
func (*GetNamespacedTagValueRequest) ProtoMessage()
func (x *GetNamespacedTagValueRequest) ProtoReflect() protoreflect.Message
func (x *GetNamespacedTagValueRequest) Reset()
func (x *GetNamespacedTagValueRequest) String() string
The request sent to the `GetOrganization` method. The `name` field is required. `organization_id` is no longer accepted.
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
}
func (*GetOrganizationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetOrganizationRequest.ProtoReflect.Descriptor instead.
func (x *GetOrganizationRequest) GetName() string
func (*GetOrganizationRequest) ProtoMessage()
func (x *GetOrganizationRequest) ProtoReflect() protoreflect.Message
func (x *GetOrganizationRequest) Reset()
func (x *GetOrganizationRequest) String() string
The request sent to the [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.
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
}
func (*GetProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.
func (x *GetProjectRequest) GetName() string
func (*GetProjectRequest) ProtoMessage()
func (x *GetProjectRequest) ProtoReflect() protoreflect.Message
func (x *GetProjectRequest) Reset()
func (x *GetProjectRequest) String() string
The request message for getting a TagKey.
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
}
func (*GetTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTagKeyRequest.ProtoReflect.Descriptor instead.
func (x *GetTagKeyRequest) GetName() string
func (*GetTagKeyRequest) ProtoMessage()
func (x *GetTagKeyRequest) ProtoReflect() protoreflect.Message
func (x *GetTagKeyRequest) Reset()
func (x *GetTagKeyRequest) String() string
The request message for getting a TagValue.
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
}
func (*GetTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTagValueRequest.ProtoReflect.Descriptor instead.
func (x *GetTagValueRequest) GetName() string
func (*GetTagValueRequest) ProtoMessage()
func (x *GetTagValueRequest) ProtoReflect() protoreflect.Message
func (x *GetTagValueRequest) Reset()
func (x *GetTagValueRequest) String() string
The request message to ListEffectiveTags
type ListEffectiveTagsRequest struct {
// Required. The full resource name of a resource for which you want to list
// the effective tags. E.g.
// "//cloudresourcemanager.googleapis.com/projects/123"
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of effective tags to return in the response.
// The server allows a maximum of 300 effective tags to return in a single
// page. 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
// `ListEffectiveTags` that indicates from where this listing should continue.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListEffectiveTagsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListEffectiveTagsRequest.ProtoReflect.Descriptor instead.
func (x *ListEffectiveTagsRequest) GetPageSize() int32
func (x *ListEffectiveTagsRequest) GetPageToken() string
func (x *ListEffectiveTagsRequest) GetParent() string
func (*ListEffectiveTagsRequest) ProtoMessage()
func (x *ListEffectiveTagsRequest) ProtoReflect() protoreflect.Message
func (x *ListEffectiveTagsRequest) Reset()
func (x *ListEffectiveTagsRequest) String() string
The response of ListEffectiveTags.
type ListEffectiveTagsResponse struct {
// A possibly paginated list of effective tags for the specified resource.
EffectiveTags []*EffectiveTag `protobuf:"bytes,1,rep,name=effective_tags,json=effectiveTags,proto3" json:"effective_tags,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
}
func (*ListEffectiveTagsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListEffectiveTagsResponse.ProtoReflect.Descriptor instead.
func (x *ListEffectiveTagsResponse) GetEffectiveTags() []*EffectiveTag
func (x *ListEffectiveTagsResponse) GetNextPageToken() string
func (*ListEffectiveTagsResponse) ProtoMessage()
func (x *ListEffectiveTagsResponse) ProtoReflect() protoreflect.Message
func (x *ListEffectiveTagsResponse) Reset()
func (x *ListEffectiveTagsResponse) String() string
The ListFolders request message.
type ListFoldersRequest struct {
// Required. The name of the parent resource whose folders are being listed.
// Only children of this parent resource are listed; descendants are not
// listed.
//
// If the parent is a folder, use the value `folders/{folder_id}`. If the
// parent is an organization, use the value `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. The
// server can return fewer folders than requested. 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
}
func (*ListFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersRequest.ProtoReflect.Descriptor instead.
func (x *ListFoldersRequest) GetPageSize() int32
func (x *ListFoldersRequest) GetPageToken() string
func (x *ListFoldersRequest) GetParent() string
func (x *ListFoldersRequest) GetShowDeleted() bool
func (*ListFoldersRequest) ProtoMessage()
func (x *ListFoldersRequest) ProtoReflect() protoreflect.Message
func (x *ListFoldersRequest) Reset()
func (x *ListFoldersRequest) String() string
The ListFolders response message.
type ListFoldersResponse struct {
// A possibly paginated list of folders that are direct descendants of
// the specified parent resource.
Folders []*Folder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
// A pagination token returned from a previous call to `ListFolders`
// that indicates from where listing should continue.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListFoldersResponse.ProtoReflect.Descriptor instead.
func (x *ListFoldersResponse) GetFolders() []*Folder
func (x *ListFoldersResponse) GetNextPageToken() string
func (*ListFoldersResponse) ProtoMessage()
func (x *ListFoldersResponse) ProtoReflect() protoreflect.Message
func (x *ListFoldersResponse) Reset()
func (x *ListFoldersResponse) String() string
The request sent to the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.
type ListProjectsRequest struct {
// Required. The name of the parent resource whose projects are being listed.
// Only children of this parent resource are listed; descendants are not
// listed.
//
// If the parent is a folder, use the value `folders/{folder_id}`. If the
// parent is an organization, use the value `organizations/{org_id}`.
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
}
func (*ListProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsRequest.ProtoReflect.Descriptor instead.
func (x *ListProjectsRequest) GetPageSize() int32
func (x *ListProjectsRequest) GetPageToken() string
func (x *ListProjectsRequest) GetParent() string
func (x *ListProjectsRequest) GetShowDeleted() bool
func (*ListProjectsRequest) ProtoMessage()
func (x *ListProjectsRequest) ProtoReflect() protoreflect.Message
func (x *ListProjectsRequest) Reset()
func (x *ListProjectsRequest) String() string
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`.
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
}
func (*ListProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsResponse.ProtoReflect.Descriptor instead.
func (x *ListProjectsResponse) GetNextPageToken() string
func (x *ListProjectsResponse) GetProjects() []*Project
func (*ListProjectsResponse) ProtoMessage()
func (x *ListProjectsResponse) ProtoReflect() protoreflect.Message
func (x *ListProjectsResponse) Reset()
func (x *ListProjectsResponse) String() string
The request message to list all TagBindings for a parent.
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
}
func (*ListTagBindingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagBindingsRequest.ProtoReflect.Descriptor instead.
func (x *ListTagBindingsRequest) GetPageSize() int32
func (x *ListTagBindingsRequest) GetPageToken() string
func (x *ListTagBindingsRequest) GetParent() string
func (*ListTagBindingsRequest) ProtoMessage()
func (x *ListTagBindingsRequest) ProtoReflect() protoreflect.Message
func (x *ListTagBindingsRequest) Reset()
func (x *ListTagBindingsRequest) String() string
The ListTagBindings response.
type ListTagBindingsResponse struct {
// A possibly paginated list of TagBindings for the specified 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
}
func (*ListTagBindingsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagBindingsResponse.ProtoReflect.Descriptor instead.
func (x *ListTagBindingsResponse) GetNextPageToken() string
func (x *ListTagBindingsResponse) GetTagBindings() []*TagBinding
func (*ListTagBindingsResponse) ProtoMessage()
func (x *ListTagBindingsResponse) ProtoReflect() protoreflect.Message
func (x *ListTagBindingsResponse) Reset()
func (x *ListTagBindingsResponse) String() string
The request message for listing the TagHolds under a TagValue.
type ListTagHoldsRequest struct {
// Required. The resource name of the parent TagValue. Must be of the form:
// `tagValues/{tag-value-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of TagHolds to return in the response. The
// server allows a maximum of 300 TagHolds 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
// `ListTagHolds` 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. Criteria used to select a subset of TagHolds parented by the
// TagValue to return. This field follows the syntax defined by aip.dev/160;
// the `holder` and `origin` fields are supported for filtering. Currently
// only `AND` syntax is supported. Some example queries are:
//
// - `holder =
// //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group`
// - `origin = 35678234`
// - `holder =
// //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group
// AND origin = 35678234`
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListTagHoldsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagHoldsRequest.ProtoReflect.Descriptor instead.
func (x *ListTagHoldsRequest) GetFilter() string
func (x *ListTagHoldsRequest) GetPageSize() int32
func (x *ListTagHoldsRequest) GetPageToken() string
func (x *ListTagHoldsRequest) GetParent() string
func (*ListTagHoldsRequest) ProtoMessage()
func (x *ListTagHoldsRequest) ProtoReflect() protoreflect.Message
func (x *ListTagHoldsRequest) Reset()
func (x *ListTagHoldsRequest) String() string
The ListTagHolds response.
type ListTagHoldsResponse struct {
// A possibly paginated list of TagHolds.
TagHolds []*TagHold `protobuf:"bytes,1,rep,name=tag_holds,json=tagHolds,proto3" json:"tag_holds,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
}
func (*ListTagHoldsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagHoldsResponse.ProtoReflect.Descriptor instead.
func (x *ListTagHoldsResponse) GetNextPageToken() string
func (x *ListTagHoldsResponse) GetTagHolds() []*TagHold
func (*ListTagHoldsResponse) ProtoMessage()
func (x *ListTagHoldsResponse) ProtoReflect() protoreflect.Message
func (x *ListTagHoldsResponse) Reset()
func (x *ListTagHoldsResponse) String() string
The request message for listing all TagKeys under a parent resource.
type ListTagKeysRequest struct {
// Required. The resource name of the TagKey's parent.
// Must be of the form `organizations/{org_id}` or `projects/{project_id}` or
// `projects/{project_number}`
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
}
func (*ListTagKeysRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagKeysRequest.ProtoReflect.Descriptor instead.
func (x *ListTagKeysRequest) GetPageSize() int32
func (x *ListTagKeysRequest) GetPageToken() string
func (x *ListTagKeysRequest) GetParent() string
func (*ListTagKeysRequest) ProtoMessage()
func (x *ListTagKeysRequest) ProtoReflect() protoreflect.Message
func (x *ListTagKeysRequest) Reset()
func (x *ListTagKeysRequest) String() string
The ListTagKeys response message.
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
}
func (*ListTagKeysResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagKeysResponse.ProtoReflect.Descriptor instead.
func (x *ListTagKeysResponse) GetNextPageToken() string
func (x *ListTagKeysResponse) GetTagKeys() []*TagKey
func (*ListTagKeysResponse) ProtoMessage()
func (x *ListTagKeysResponse) ProtoReflect() protoreflect.Message
func (x *ListTagKeysResponse) Reset()
func (x *ListTagKeysResponse) String() string
The request message for listing TagValues for the specified TagKey. Resource name for TagKey, parent of the TagValues to be listed, in the format `tagKeys/123`.
type ListTagValuesRequest struct {
// Required.
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
}
func (*ListTagValuesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTagValuesRequest.ProtoReflect.Descriptor instead.
func (x *ListTagValuesRequest) GetPageSize() int32
func (x *ListTagValuesRequest) GetPageToken() string
func (x *ListTagValuesRequest) GetParent() string
func (*ListTagValuesRequest) ProtoMessage()
func (x *ListTagValuesRequest) ProtoReflect() protoreflect.Message
func (x *ListTagValuesRequest) Reset()
func (x *ListTagValuesRequest) String() string
The ListTagValues response.
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
}
func (*ListTagValuesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTagValuesResponse.ProtoReflect.Descriptor instead.
func (x *ListTagValuesResponse) GetNextPageToken() string
func (x *ListTagValuesResponse) GetTagValues() []*TagValue
func (*ListTagValuesResponse) ProtoMessage()
func (x *ListTagValuesResponse) ProtoReflect() protoreflect.Message
func (x *ListTagValuesResponse) Reset()
func (x *ListTagValuesResponse) String() string
Metadata pertaining to the folder move process.
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
}
func (*MoveFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use MoveFolderMetadata.ProtoReflect.Descriptor instead.
func (x *MoveFolderMetadata) GetDestinationParent() string
func (x *MoveFolderMetadata) GetDisplayName() string
func (x *MoveFolderMetadata) GetSourceParent() string
func (*MoveFolderMetadata) ProtoMessage()
func (x *MoveFolderMetadata) ProtoReflect() protoreflect.Message
func (x *MoveFolderMetadata) Reset()
func (x *MoveFolderMetadata) String() string
The MoveFolder request message.
type MoveFolderRequest struct {
// Required. The resource name of the Folder to move.
// Must be of the form folders/{folder_id}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The resource name of the folder or organization 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
}
func (*MoveFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveFolderRequest.ProtoReflect.Descriptor instead.
func (x *MoveFolderRequest) GetDestinationParent() string
func (x *MoveFolderRequest) GetName() string
func (*MoveFolderRequest) ProtoMessage()
func (x *MoveFolderRequest) ProtoReflect() protoreflect.Message
func (x *MoveFolderRequest) Reset()
func (x *MoveFolderRequest) String() string
A status object which is used as the `metadata` field for the Operation returned by MoveProject.
type MoveProjectMetadata struct {
// contains filtered or unexported fields
}
func (*MoveProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use MoveProjectMetadata.ProtoReflect.Descriptor instead.
func (*MoveProjectMetadata) ProtoMessage()
func (x *MoveProjectMetadata) ProtoReflect() protoreflect.Message
func (x *MoveProjectMetadata) Reset()
func (x *MoveProjectMetadata) String() string
The request sent to [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method.
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
}
func (*MoveProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use MoveProjectRequest.ProtoReflect.Descriptor instead.
func (x *MoveProjectRequest) GetDestinationParent() string
func (x *MoveProjectRequest) GetName() string
func (*MoveProjectRequest) ProtoMessage()
func (x *MoveProjectRequest) ProtoReflect() protoreflect.Message
func (x *MoveProjectRequest) Reset()
func (x *MoveProjectRequest) String() string
The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.
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 *timestamppb.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 *timestamppb.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 *timestamppb.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
}
func (*Organization) Descriptor() ([]byte, []int)
Deprecated: Use Organization.ProtoReflect.Descriptor instead.
func (x *Organization) GetCreateTime() *timestamppb.Timestamp
func (x *Organization) GetDeleteTime() *timestamppb.Timestamp
func (x *Organization) GetDirectoryCustomerId() string
func (x *Organization) GetDisplayName() string
func (x *Organization) GetEtag() string
func (x *Organization) GetName() string
func (m *Organization) GetOwner() isOrganization_Owner
func (x *Organization) GetState() Organization_State
func (x *Organization) GetUpdateTime() *timestamppb.Timestamp
func (*Organization) ProtoMessage()
func (x *Organization) ProtoReflect() protoreflect.Message
func (x *Organization) Reset()
func (x *Organization) String() string
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 lifecycle states.
type Organization_State int32
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() protoreflect.EnumDescriptor
func (x Organization_State) Enum() *Organization_State
func (Organization_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Organization_State.Descriptor instead.
func (x Organization_State) Number() protoreflect.EnumNumber
func (x Organization_State) String() string
func (Organization_State) Type() protoreflect.EnumType
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.
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 *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.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 *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.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 *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewOrganizationsClient(cc grpc.ClientConnInterface) OrganizationsClient
OrganizationsServer is the server API for Organizations service.
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, *iampb.GetIamPolicyRequest) (*iampb.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, *iampb.SetIamPolicyRequest) (*iampb.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, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
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.
type Project struct {
// Output only. The unique resource name of the project. It is an int64
// generated number prefixed by "projects/".
//
// Example: `projects/415104041262`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. A reference to a parent Resource. eg., `organizations/123` or
// `folders/876`.
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// Immutable. The unique, user-assigned id of the project.
// It must be 6 to 30 lowercase ASCII letters, digits, or hyphens.
// It must start with a letter.
// Trailing hyphens are prohibited.
//
// Example: `tokyo-rain-123`
ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Output only. The project lifecycle state.
State Project_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.resourcemanager.v3.Project_State" json:"state,omitempty"`
// Optional. A user-assigned display name of the project.
// When present it must be between 4 to 30 characters.
// Allowed characters are: lowercase and uppercase letters, numbers,
// hyphen, single-quote, double-quote, space, and exclamation point.
//
// Example: `My Project`
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Creation time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The most recent time this resource was modified.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time at which this resource was requested for deletion.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,8,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 Project 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,9,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. The labels associated with this project.
//
// Label keys must be between 1 and 63 characters long and must conform
// to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
//
// Label values must be between 0 and 63 characters long and must conform
// to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
//
// No more than 64 labels can be associated with a given resource.
//
// Clients should store labels in a representation such as JSON that does not
// depend on specific characters being disallowed.
//
// Example: `"myBusinessDimension" : "businessValue"`
Labels map[string]string `protobuf:"bytes,10,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*Project) Descriptor() ([]byte, []int)
Deprecated: Use Project.ProtoReflect.Descriptor instead.
func (x *Project) GetCreateTime() *timestamppb.Timestamp
func (x *Project) GetDeleteTime() *timestamppb.Timestamp
func (x *Project) GetDisplayName() string
func (x *Project) GetEtag() string
func (x *Project) GetLabels() map[string]string
func (x *Project) GetName() string
func (x *Project) GetParent() string
func (x *Project) GetProjectId() string
func (x *Project) GetState() Project_State
func (x *Project) GetUpdateTime() *timestamppb.Timestamp
func (*Project) ProtoMessage()
func (x *Project) ProtoReflect() protoreflect.Message
func (x *Project) Reset()
func (x *Project) String() string
Project lifecycle states.
type Project_State int32
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() protoreflect.EnumDescriptor
func (x Project_State) Enum() *Project_State
func (Project_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Project_State.Descriptor instead.
func (x Project_State) Number() protoreflect.EnumNumber
func (x Project_State) String() string
func (Project_State) Type() protoreflect.EnumType
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.
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) (*longrunningpb.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) (*longrunningpb.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.move` permission on the
// project, on the project's current and proposed new parent.
//
// If project has no current parent, or it currently does not have an
// associated organization resource, you will also need the
// `resourcemanager.projects.setIamPolicy` permission in the project.
MoveProject(ctx context.Context, in *MoveProjectRequest, opts ...grpc.CallOption) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Returns the IAM access control policy for the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123.
// Permission is denied if the policy or the resource do not exist.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the IAM access control policy for the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123.
//
// 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.
//
// + 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. If the project is part of an organization, you can remove all
// owners, potentially making the organization inaccessible.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123..
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewProjectsClient(cc grpc.ClientConnInterface) ProjectsClient
ProjectsServer is the server API for Projects service.
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) (*longrunningpb.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) (*longrunningpb.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.move` permission on the
// project, on the project's current and proposed new parent.
//
// If project has no current parent, or it currently does not have an
// associated organization resource, you will also need the
// `resourcemanager.projects.setIamPolicy` permission in the project.
MoveProject(context.Context, *MoveProjectRequest) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Returns the IAM access control policy for the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123.
// Permission is denied if the policy or the resource do not exist.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the IAM access control policy for the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123.
//
// 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.
//
// + 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. If the project is part of an organization, you can remove all
// owners, potentially making the organization inaccessible.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified project, in the
// format `projects/{ProjectIdOrNumber}` e.g. projects/123..
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
A purpose for each policy engine requiring such an integration. A single policy engine may have multiple purposes defined, however a TagKey may only specify a single purpose.
type Purpose int32
const (
// Unspecified purpose.
Purpose_PURPOSE_UNSPECIFIED Purpose = 0
// Purpose for Compute Engine firewalls.
// A corresponding `purpose_data` should be set for the network the tag is
// intended for. The key should be `network` and the value should be in
// either of these two formats:
//
// -
// `https://www.googleapis.com/compute/{compute_version}/projects/{project_id}/global/networks/{network_id}`
// - `{project_id}/{network_name}`
//
// Examples:
//
// -
// `https://www.googleapis.com/compute/staging_v1/projects/fail-closed-load-testing/global/networks/6992953698831725600`
// - `fail-closed-load-testing/load-testing-network`
Purpose_GCE_FIREWALL Purpose = 1
)
func (Purpose) Descriptor() protoreflect.EnumDescriptor
func (x Purpose) Enum() *Purpose
func (Purpose) EnumDescriptor() ([]byte, []int)
Deprecated: Use Purpose.Descriptor instead.
func (x Purpose) Number() protoreflect.EnumNumber
func (x Purpose) String() string
func (Purpose) Type() protoreflect.EnumType
The request message for searching folders.
type SearchFoldersRequest struct {
// Optional. The maximum number of folders to return in the response. The
// server can return fewer folders than requested. 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
}
func (*SearchFoldersRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersRequest.ProtoReflect.Descriptor instead.
func (x *SearchFoldersRequest) GetPageSize() int32
func (x *SearchFoldersRequest) GetPageToken() string
func (x *SearchFoldersRequest) GetQuery() string
func (*SearchFoldersRequest) ProtoMessage()
func (x *SearchFoldersRequest) ProtoReflect() protoreflect.Message
func (x *SearchFoldersRequest) Reset()
func (x *SearchFoldersRequest) String() string
The response message for searching folders.
type SearchFoldersResponse struct {
// A possibly paginated folder search results.
// the specified parent resource.
Folders []*Folder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
// A pagination token returned from a previous call to `SearchFolders`
// that indicates from where searching should continue.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*SearchFoldersResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchFoldersResponse.ProtoReflect.Descriptor instead.
func (x *SearchFoldersResponse) GetFolders() []*Folder
func (x *SearchFoldersResponse) GetNextPageToken() string
func (*SearchFoldersResponse) ProtoMessage()
func (x *SearchFoldersResponse) ProtoReflect() protoreflect.Message
func (x *SearchFoldersResponse) Reset()
func (x *SearchFoldersResponse) String() string
The request sent to the `SearchOrganizations` method.
type SearchOrganizationsRequest struct {
// Optional. The maximum number of organizations to return in the response.
// The server can return fewer organizations than requested. 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
}
func (*SearchOrganizationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchOrganizationsRequest.ProtoReflect.Descriptor instead.
func (x *SearchOrganizationsRequest) GetPageSize() int32
func (x *SearchOrganizationsRequest) GetPageToken() string
func (x *SearchOrganizationsRequest) GetQuery() string
func (*SearchOrganizationsRequest) ProtoMessage()
func (x *SearchOrganizationsRequest) ProtoReflect() protoreflect.Message
func (x *SearchOrganizationsRequest) Reset()
func (x *SearchOrganizationsRequest) String() string
The response returned from the `SearchOrganizations` method.
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
}
func (*SearchOrganizationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchOrganizationsResponse.ProtoReflect.Descriptor instead.
func (x *SearchOrganizationsResponse) GetNextPageToken() string
func (x *SearchOrganizationsResponse) GetOrganizations() []*Organization
func (*SearchOrganizationsResponse) ProtoMessage()
func (x *SearchOrganizationsResponse) ProtoReflect() protoreflect.Message
func (x *SearchOrganizationsResponse) Reset()
func (x *SearchOrganizationsResponse) String() string
The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.
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, then it will return results that match any of the
// fields. Some eligible fields are:
//
// - **`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.<key>` (where `<key>` is the name of a label)**: Filters by label
// name.
//
// Search expressions are case insensitive.
//
// Some examples queries:
//
// - **`name:how*`**: The project's name starts with "how".
// - **`name:Howl`**: The project's name is `Howl` or `howl`.
// - **`name:HOWL`**: Equivalent to above.
// - **`NAME:howl`**: Equivalent to above.
// - **`labels.color:*`**: The project has the label `color`.
// - **`labels.color:red`**: The project's label `color` has the value `red`.
// - **`labels.color:red labels.size:big`**: The project's label `color` has
// the value `red` or its label `size` has the value `big`.
//
// If no query is specified, the call will return projects for which the user
// has the `resourcemanager.projects.get` permission.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,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"`
// contains filtered or unexported fields
}
func (*SearchProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsRequest.ProtoReflect.Descriptor instead.
func (x *SearchProjectsRequest) GetPageSize() int32
func (x *SearchProjectsRequest) GetPageToken() string
func (x *SearchProjectsRequest) GetQuery() string
func (*SearchProjectsRequest) ProtoMessage()
func (x *SearchProjectsRequest) ProtoReflect() protoreflect.Message
func (x *SearchProjectsRequest) Reset()
func (x *SearchProjectsRequest) String() string
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.
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
}
func (*SearchProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsResponse.ProtoReflect.Descriptor instead.
func (x *SearchProjectsResponse) GetNextPageToken() string
func (x *SearchProjectsResponse) GetProjects() []*Project
func (*SearchProjectsResponse) ProtoMessage()
func (x *SearchProjectsResponse) ProtoReflect() protoreflect.Message
func (x *SearchProjectsResponse) Reset()
func (x *SearchProjectsResponse) String() string
A TagBinding represents a connection between a TagValue and a cloud resource Once a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.
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"`
// The namespaced name for the TagValue of the TagBinding.
// Must be in the format
// `{parent_id}/{tag_key_short_name}/{short_name}`.
//
// For methods that support TagValue namespaced name, only one of
// tag_value_namespaced_name or tag_value may be filled. Requests with both
// fields will be rejected.
TagValueNamespacedName string `protobuf:"bytes,4,opt,name=tag_value_namespaced_name,json=tagValueNamespacedName,proto3" json:"tag_value_namespaced_name,omitempty"`
// contains filtered or unexported fields
}
func (*TagBinding) Descriptor() ([]byte, []int)
Deprecated: Use TagBinding.ProtoReflect.Descriptor instead.
func (x *TagBinding) GetName() string
func (x *TagBinding) GetParent() string
func (x *TagBinding) GetTagValue() string
func (x *TagBinding) GetTagValueNamespacedName() string
func (*TagBinding) ProtoMessage()
func (x *TagBinding) ProtoReflect() protoreflect.Message
func (x *TagBinding) Reset()
func (x *TagBinding) String() string
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.
type TagBindingsClient interface {
// Lists the TagBindings for the given Google 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 Google Cloud resource.
CreateTagBinding(ctx context.Context, in *CreateTagBindingRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a TagBinding.
DeleteTagBinding(ctx context.Context, in *DeleteTagBindingRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Return a list of effective tags for the given Google Cloud resource, as
// specified in `parent`.
ListEffectiveTags(ctx context.Context, in *ListEffectiveTagsRequest, opts ...grpc.CallOption) (*ListEffectiveTagsResponse, error)
}
func NewTagBindingsClient(cc grpc.ClientConnInterface) TagBindingsClient
TagBindingsServer is the server API for TagBindings service.
type TagBindingsServer interface {
// Lists the TagBindings for the given Google 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 Google Cloud resource.
CreateTagBinding(context.Context, *CreateTagBindingRequest) (*longrunningpb.Operation, error)
// Deletes a TagBinding.
DeleteTagBinding(context.Context, *DeleteTagBindingRequest) (*longrunningpb.Operation, error)
// Return a list of effective tags for the given Google Cloud resource, as
// specified in `parent`.
ListEffectiveTags(context.Context, *ListEffectiveTagsRequest) (*ListEffectiveTagsResponse, error)
}
A TagHold represents the use of a TagValue that is not captured by TagBindings. If a TagValue has any TagHolds, deletion will be blocked. This resource is intended to be created in the same cloud location as the `holder`.
type TagHold struct {
// Output only. The resource name of a TagHold. This is a String of the form:
// `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`
// (e.g. `tagValues/123/tagHolds/456`). This resource name is generated by
// the server.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The name of the resource where the TagValue is being used. Must
// be less than 200 characters. E.g.
// `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group`
Holder string `protobuf:"bytes,2,opt,name=holder,proto3" json:"holder,omitempty"`
// Optional. An optional string representing the origin of this request. This
// field should include human-understandable information to distinguish
// origins from each other. Must be less than 200 characters. E.g.
// `migs-35678234`
Origin string `protobuf:"bytes,3,opt,name=origin,proto3" json:"origin,omitempty"`
// Optional. A URL where an end user can learn more about removing this hold.
// E.g.
// `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing`
HelpLink string `protobuf:"bytes,4,opt,name=help_link,json=helpLink,proto3" json:"help_link,omitempty"`
// Output only. The time this TagHold was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
func (*TagHold) Descriptor() ([]byte, []int)
Deprecated: Use TagHold.ProtoReflect.Descriptor instead.
func (x *TagHold) GetCreateTime() *timestamppb.Timestamp
func (x *TagHold) GetHelpLink() string
func (x *TagHold) GetHolder() string
func (x *TagHold) GetName() string
func (x *TagHold) GetOrigin() string
func (*TagHold) ProtoMessage()
func (x *TagHold) ProtoReflect() protoreflect.Message
func (x *TagHold) Reset()
func (x *TagHold) String() string
TagHoldsClient is the client API for TagHolds service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type TagHoldsClient interface {
// Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same
// resource and origin exists under the same TagValue.
CreateTagHold(ctx context.Context, in *CreateTagHoldRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a TagHold.
DeleteTagHold(ctx context.Context, in *DeleteTagHoldRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists TagHolds under a TagValue.
ListTagHolds(ctx context.Context, in *ListTagHoldsRequest, opts ...grpc.CallOption) (*ListTagHoldsResponse, error)
}
func NewTagHoldsClient(cc grpc.ClientConnInterface) TagHoldsClient
TagHoldsServer is the server API for TagHolds service.
type TagHoldsServer interface {
// Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same
// resource and origin exists under the same TagValue.
CreateTagHold(context.Context, *CreateTagHoldRequest) (*longrunningpb.Operation, error)
// Deletes a TagHold.
DeleteTagHold(context.Context, *DeleteTagHoldRequest) (*longrunningpb.Operation, error)
// Lists TagHolds under a TagValue.
ListTagHolds(context.Context, *ListTagHoldsRequest) (*ListTagHoldsResponse, error)
}
A TagKey, used to group a set of TagValues.
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 TagKey's parent. A TagKey can be
// parented by an Organization or a Project. For a TagKey parented by an
// Organization, its parent must be in the form `organizations/{org_id}`. For
// a TagKey parented by a Project, its parent can be in the form
// `projects/{project_id}` or `projects/{project_number}`.
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 *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Update time.
UpdateTime *timestamppb.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"`
// Optional. A purpose denotes that this Tag is intended for use in policies
// of a specific policy engine, and will involve that policy engine in
// management operations involving this Tag. A purpose does not grant a
// policy engine exclusive rights to the Tag, and it may be referenced by
// other policy engines.
//
// A purpose cannot be changed once set.
Purpose Purpose `protobuf:"varint,11,opt,name=purpose,proto3,enum=google.cloud.resourcemanager.v3.Purpose" json:"purpose,omitempty"`
// Optional. Purpose data corresponds to the policy system that the tag is
// intended for. See documentation for `Purpose` for formatting of this field.
//
// Purpose data cannot be changed once set.
PurposeData map[string]string `protobuf:"bytes,12,rep,name=purpose_data,json=purposeData,proto3" json:"purpose_data,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*TagKey) Descriptor() ([]byte, []int)
Deprecated: Use TagKey.ProtoReflect.Descriptor instead.
func (x *TagKey) GetCreateTime() *timestamppb.Timestamp
func (x *TagKey) GetDescription() string
func (x *TagKey) GetEtag() string
func (x *TagKey) GetName() string
func (x *TagKey) GetNamespacedName() string
func (x *TagKey) GetParent() string
func (x *TagKey) GetPurpose() Purpose
func (x *TagKey) GetPurposeData() map[string]string
func (x *TagKey) GetShortName() string
func (x *TagKey) GetUpdateTime() *timestamppb.Timestamp
func (*TagKey) ProtoMessage()
func (x *TagKey) ProtoReflect() protoreflect.Message
func (x *TagKey) Reset()
func (x *TagKey) String() string
TagKeysClient is the client API for TagKeys service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type TagKeysClient interface {
// Lists all TagKeys for a parent resource.
ListTagKeys(ctx context.Context, in *ListTagKeysRequest, opts ...grpc.CallOption) (*ListTagKeysResponse, error)
// Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the
// key does not exist or the user does not have permission to view it.
GetTagKey(ctx context.Context, in *GetTagKeyRequest, opts ...grpc.CallOption) (*TagKey, error)
// Retrieves a TagKey by its namespaced name.
// This method will return `PERMISSION_DENIED` if the key does not exist
// or the user does not have permission to view it.
GetNamespacedTagKey(ctx context.Context, in *GetNamespacedTagKeyRequest, opts ...grpc.CallOption) (*TagKey, error)
// Creates a new TagKey. If another request with the same parameters is
// sent while the original request is in process, the second request
// will receive an error. A maximum of 1000 TagKeys can exist under a parent
// at any given time.
CreateTagKey(ctx context.Context, in *CreateTagKeyRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the attributes of the TagKey resource.
UpdateTagKey(ctx context.Context, in *UpdateTagKeyRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a TagKey. The TagKey cannot be deleted if it has any child
// TagValues.
DeleteTagKey(ctx context.Context, in *DeleteTagKeyRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the access control policy for a TagKey. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the TagKey's resource name. For example, "tagKeys/1234".
// The caller must have
// `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on
// the specified TagKey.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on a TagKey, replacing any existing
// policy. The `resource` field should be the TagKey's resource name.
// For example, "tagKeys/1234".
// The caller must have `resourcemanager.tagKeys.setIamPolicy` permission
// on the identified tagValue.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified TagKey.
// The `resource` field should be the TagKey's resource name.
// For example, "tagKeys/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewTagKeysClient(cc grpc.ClientConnInterface) TagKeysClient
TagKeysServer is the server API for TagKeys service.
type TagKeysServer interface {
// Lists all TagKeys for a parent resource.
ListTagKeys(context.Context, *ListTagKeysRequest) (*ListTagKeysResponse, error)
// Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the
// key does not exist or the user does not have permission to view it.
GetTagKey(context.Context, *GetTagKeyRequest) (*TagKey, error)
// Retrieves a TagKey by its namespaced name.
// This method will return `PERMISSION_DENIED` if the key does not exist
// or the user does not have permission to view it.
GetNamespacedTagKey(context.Context, *GetNamespacedTagKeyRequest) (*TagKey, error)
// Creates a new TagKey. If another request with the same parameters is
// sent while the original request is in process, the second request
// will receive an error. A maximum of 1000 TagKeys can exist under a parent
// at any given time.
CreateTagKey(context.Context, *CreateTagKeyRequest) (*longrunningpb.Operation, error)
// Updates the attributes of the TagKey resource.
UpdateTagKey(context.Context, *UpdateTagKeyRequest) (*longrunningpb.Operation, error)
// Deletes a TagKey. The TagKey cannot be deleted if it has any child
// TagValues.
DeleteTagKey(context.Context, *DeleteTagKeyRequest) (*longrunningpb.Operation, error)
// Gets the access control policy for a TagKey. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the TagKey's resource name. For example, "tagKeys/1234".
// The caller must have
// `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on
// the specified TagKey.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on a TagKey, replacing any existing
// policy. The `resource` field should be the TagKey's resource name.
// For example, "tagKeys/1234".
// The caller must have `resourcemanager.tagKeys.setIamPolicy` permission
// on the identified tagValue.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified TagKey.
// The `resource` field should be the TagKey's resource name.
// For example, "tagKeys/1234".
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.
type TagValue struct {
// Immutable. Resource name for TagValue in the format `tagValues/456`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The resource name of the new TagValue's parent TagKey.
// Must be of the form `tagKeys/{tag_key_id}`.
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Immutable. User-assigned short name for TagValue. The short name
// should be unique for TagValues within the same parent TagKey.
//
// The short name must be 63 characters or less, 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. The namespaced name of the TagValue. Can be in the form
// `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
// `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
// `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
NamespacedName string `protobuf:"bytes,4,opt,name=namespaced_name,json=namespacedName,proto3" json:"namespaced_name,omitempty"`
// Optional. User-assigned description of the TagValue.
// Must not exceed 256 characters.
//
// Read-write.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Creation time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Update time.
UpdateTime *timestamppb.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 UpdateTagValueRequest for
// details.
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*TagValue) Descriptor() ([]byte, []int)
Deprecated: Use TagValue.ProtoReflect.Descriptor instead.
func (x *TagValue) GetCreateTime() *timestamppb.Timestamp
func (x *TagValue) GetDescription() string
func (x *TagValue) GetEtag() string
func (x *TagValue) GetName() string
func (x *TagValue) GetNamespacedName() string
func (x *TagValue) GetParent() string
func (x *TagValue) GetShortName() string
func (x *TagValue) GetUpdateTime() *timestamppb.Timestamp
func (*TagValue) ProtoMessage()
func (x *TagValue) ProtoReflect() protoreflect.Message
func (x *TagValue) Reset()
func (x *TagValue) String() string
TagValuesClient is the client API for TagValues service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type TagValuesClient interface {
// Lists all TagValues for a specific TagKey.
ListTagValues(ctx context.Context, in *ListTagValuesRequest, opts ...grpc.CallOption) (*ListTagValuesResponse, error)
// Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the
// value does not exist or the user does not have permission to view it.
GetTagValue(ctx context.Context, in *GetTagValueRequest, opts ...grpc.CallOption) (*TagValue, error)
// Retrieves a TagValue by its namespaced name.
// This method will return `PERMISSION_DENIED` if the value does not exist
// or the user does not have permission to view it.
GetNamespacedTagValue(ctx context.Context, in *GetNamespacedTagValueRequest, opts ...grpc.CallOption) (*TagValue, error)
// Creates a TagValue as a child of the specified TagKey. If a another
// request with the same parameters is sent while the original request is in
// process the second request will receive an error. A maximum of 1000
// TagValues can exist under a TagKey at any given time.
CreateTagValue(ctx context.Context, in *CreateTagValueRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the attributes of the TagValue resource.
UpdateTagValue(ctx context.Context, in *UpdateTagValueRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a TagValue. The TagValue cannot have any bindings when it is
// deleted.
DeleteTagValue(ctx context.Context, in *DeleteTagValueRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the access control policy for a TagValue. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the TagValue's resource name. For example: `tagValues/1234`.
// The caller must have the
// `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on
// the identified TagValue to get the access control policy.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on a TagValue, replacing any existing
// policy. The `resource` field should be the TagValue's resource name.
// For example: `tagValues/1234`.
// The caller must have `resourcemanager.tagValues.setIamPolicy` permission
// on the identified tagValue.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified TagValue.
// The `resource` field should be the TagValue's resource name. For example:
// `tagValues/1234`.
//
// There are no permissions required for making this API call.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewTagValuesClient(cc grpc.ClientConnInterface) TagValuesClient
TagValuesServer is the server API for TagValues service.
type TagValuesServer interface {
// Lists all TagValues for a specific TagKey.
ListTagValues(context.Context, *ListTagValuesRequest) (*ListTagValuesResponse, error)
// Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the
// value does not exist or the user does not have permission to view it.
GetTagValue(context.Context, *GetTagValueRequest) (*TagValue, error)
// Retrieves a TagValue by its namespaced name.
// This method will return `PERMISSION_DENIED` if the value does not exist
// or the user does not have permission to view it.
GetNamespacedTagValue(context.Context, *GetNamespacedTagValueRequest) (*TagValue, error)
// Creates a TagValue as a child of the specified TagKey. If a another
// request with the same parameters is sent while the original request is in
// process the second request will receive an error. A maximum of 1000
// TagValues can exist under a TagKey at any given time.
CreateTagValue(context.Context, *CreateTagValueRequest) (*longrunningpb.Operation, error)
// Updates the attributes of the TagValue resource.
UpdateTagValue(context.Context, *UpdateTagValueRequest) (*longrunningpb.Operation, error)
// Deletes a TagValue. The TagValue cannot have any bindings when it is
// deleted.
DeleteTagValue(context.Context, *DeleteTagValueRequest) (*longrunningpb.Operation, error)
// Gets the access control policy for a TagValue. The returned policy may be
// empty if no such policy or resource exists. The `resource` field should
// be the TagValue's resource name. For example: `tagValues/1234`.
// The caller must have the
// `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on
// the identified TagValue to get the access control policy.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on a TagValue, replacing any existing
// policy. The `resource` field should be the TagValue's resource name.
// For example: `tagValues/1234`.
// The caller must have `resourcemanager.tagValues.setIamPolicy` permission
// on the identified tagValue.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has on the specified TagValue.
// The `resource` field should be the TagValue's resource name. For example:
// `tagValues/1234`.
//
// There are no permissions required for making this API call.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.
type UndeleteFolderMetadata struct {
// contains filtered or unexported fields
}
func (*UndeleteFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteFolderMetadata.ProtoReflect.Descriptor instead.
func (*UndeleteFolderMetadata) ProtoMessage()
func (x *UndeleteFolderMetadata) ProtoReflect() protoreflect.Message
func (x *UndeleteFolderMetadata) Reset()
func (x *UndeleteFolderMetadata) String() string
The UndeleteFolder request message.
type UndeleteFolderRequest struct {
// Required. The resource name of the folder to undelete.
// Must be of the form `folders/{folder_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*UndeleteFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteFolderRequest.ProtoReflect.Descriptor instead.
func (x *UndeleteFolderRequest) GetName() string
func (*UndeleteFolderRequest) ProtoMessage()
func (x *UndeleteFolderRequest) ProtoReflect() protoreflect.Message
func (x *UndeleteFolderRequest) Reset()
func (x *UndeleteFolderRequest) String() string
A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.
type UndeleteOrganizationMetadata struct {
// contains filtered or unexported fields
}
func (*UndeleteOrganizationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteOrganizationMetadata.ProtoReflect.Descriptor instead.
func (*UndeleteOrganizationMetadata) ProtoMessage()
func (x *UndeleteOrganizationMetadata) ProtoReflect() protoreflect.Message
func (x *UndeleteOrganizationMetadata) Reset()
func (x *UndeleteOrganizationMetadata) String() string
A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.
type UndeleteProjectMetadata struct {
// contains filtered or unexported fields
}
func (*UndeleteProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteProjectMetadata.ProtoReflect.Descriptor instead.
func (*UndeleteProjectMetadata) ProtoMessage()
func (x *UndeleteProjectMetadata) ProtoReflect() protoreflect.Message
func (x *UndeleteProjectMetadata) Reset()
func (x *UndeleteProjectMetadata) String() string
The request sent to the [UndeleteProject] [google.cloud.resourcemanager.v3.Projects.UndeleteProject] method.
type UndeleteProjectRequest struct {
// Required. The name of the project (for example, `projects/415104041262`).
//
// Required.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*UndeleteProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteProjectRequest.ProtoReflect.Descriptor instead.
func (x *UndeleteProjectRequest) GetName() string
func (*UndeleteProjectRequest) ProtoMessage()
func (x *UndeleteProjectRequest) ProtoReflect() protoreflect.Message
func (x *UndeleteProjectRequest) Reset()
func (x *UndeleteProjectRequest) String() string
UnimplementedFoldersServer can be embedded to have forward compatible implementations.
type UnimplementedFoldersServer struct {
}
func (*UnimplementedFoldersServer) CreateFolder(context.Context, *CreateFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) DeleteFolder(context.Context, *DeleteFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) GetFolder(context.Context, *GetFolderRequest) (*Folder, error)
func (*UnimplementedFoldersServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedFoldersServer) ListFolders(context.Context, *ListFoldersRequest) (*ListFoldersResponse, error)
func (*UnimplementedFoldersServer) MoveFolder(context.Context, *MoveFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) SearchFolders(context.Context, *SearchFoldersRequest) (*SearchFoldersResponse, error)
func (*UnimplementedFoldersServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedFoldersServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedFoldersServer) UndeleteFolder(context.Context, *UndeleteFolderRequest) (*longrunningpb.Operation, error)
func (*UnimplementedFoldersServer) UpdateFolder(context.Context, *UpdateFolderRequest) (*longrunningpb.Operation, error)
UnimplementedOrganizationsServer can be embedded to have forward compatible implementations.
type UnimplementedOrganizationsServer struct {
}
func (*UnimplementedOrganizationsServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedOrganizationsServer) GetOrganization(context.Context, *GetOrganizationRequest) (*Organization, error)
func (*UnimplementedOrganizationsServer) SearchOrganizations(context.Context, *SearchOrganizationsRequest) (*SearchOrganizationsResponse, error)
func (*UnimplementedOrganizationsServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedOrganizationsServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
UnimplementedProjectsServer can be embedded to have forward compatible implementations.
type UnimplementedProjectsServer struct {
}
func (*UnimplementedProjectsServer) CreateProject(context.Context, *CreateProjectRequest) (*longrunningpb.Operation, error)
func (*UnimplementedProjectsServer) DeleteProject(context.Context, *DeleteProjectRequest) (*longrunningpb.Operation, error)
func (*UnimplementedProjectsServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedProjectsServer) GetProject(context.Context, *GetProjectRequest) (*Project, error)
func (*UnimplementedProjectsServer) ListProjects(context.Context, *ListProjectsRequest) (*ListProjectsResponse, error)
func (*UnimplementedProjectsServer) MoveProject(context.Context, *MoveProjectRequest) (*longrunningpb.Operation, error)
func (*UnimplementedProjectsServer) SearchProjects(context.Context, *SearchProjectsRequest) (*SearchProjectsResponse, error)
func (*UnimplementedProjectsServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedProjectsServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedProjectsServer) UndeleteProject(context.Context, *UndeleteProjectRequest) (*longrunningpb.Operation, error)
func (*UnimplementedProjectsServer) UpdateProject(context.Context, *UpdateProjectRequest) (*longrunningpb.Operation, error)
UnimplementedTagBindingsServer can be embedded to have forward compatible implementations.
type UnimplementedTagBindingsServer struct {
}
func (*UnimplementedTagBindingsServer) CreateTagBinding(context.Context, *CreateTagBindingRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagBindingsServer) DeleteTagBinding(context.Context, *DeleteTagBindingRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagBindingsServer) ListEffectiveTags(context.Context, *ListEffectiveTagsRequest) (*ListEffectiveTagsResponse, error)
func (*UnimplementedTagBindingsServer) ListTagBindings(context.Context, *ListTagBindingsRequest) (*ListTagBindingsResponse, error)
UnimplementedTagHoldsServer can be embedded to have forward compatible implementations.
type UnimplementedTagHoldsServer struct {
}
func (*UnimplementedTagHoldsServer) CreateTagHold(context.Context, *CreateTagHoldRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagHoldsServer) DeleteTagHold(context.Context, *DeleteTagHoldRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagHoldsServer) ListTagHolds(context.Context, *ListTagHoldsRequest) (*ListTagHoldsResponse, error)
UnimplementedTagKeysServer can be embedded to have forward compatible implementations.
type UnimplementedTagKeysServer struct {
}
func (*UnimplementedTagKeysServer) CreateTagKey(context.Context, *CreateTagKeyRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagKeysServer) DeleteTagKey(context.Context, *DeleteTagKeyRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagKeysServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedTagKeysServer) GetNamespacedTagKey(context.Context, *GetNamespacedTagKeyRequest) (*TagKey, error)
func (*UnimplementedTagKeysServer) GetTagKey(context.Context, *GetTagKeyRequest) (*TagKey, error)
func (*UnimplementedTagKeysServer) ListTagKeys(context.Context, *ListTagKeysRequest) (*ListTagKeysResponse, error)
func (*UnimplementedTagKeysServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedTagKeysServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedTagKeysServer) UpdateTagKey(context.Context, *UpdateTagKeyRequest) (*longrunningpb.Operation, error)
UnimplementedTagValuesServer can be embedded to have forward compatible implementations.
type UnimplementedTagValuesServer struct {
}
func (*UnimplementedTagValuesServer) CreateTagValue(context.Context, *CreateTagValueRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagValuesServer) DeleteTagValue(context.Context, *DeleteTagValueRequest) (*longrunningpb.Operation, error)
func (*UnimplementedTagValuesServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedTagValuesServer) GetNamespacedTagValue(context.Context, *GetNamespacedTagValueRequest) (*TagValue, error)
func (*UnimplementedTagValuesServer) GetTagValue(context.Context, *GetTagValueRequest) (*TagValue, error)
func (*UnimplementedTagValuesServer) ListTagValues(context.Context, *ListTagValuesRequest) (*ListTagValuesResponse, error)
func (*UnimplementedTagValuesServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedTagValuesServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedTagValuesServer) UpdateTagValue(context.Context, *UpdateTagValueRequest) (*longrunningpb.Operation, error)
A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.
type UpdateFolderMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateFolderMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateFolderMetadata.ProtoReflect.Descriptor instead.
func (*UpdateFolderMetadata) ProtoMessage()
func (x *UpdateFolderMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateFolderMetadata) Reset()
func (x *UpdateFolderMetadata) String() string
The request sent to the [UpdateFolder][google.cloud.resourcemanager.v3.Folder.UpdateFolder] method.
Only the `display_name` field can be changed. All other fields will be ignored. Use the [MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder] method to change the `parent` field.
type UpdateFolderRequest struct {
// Required. The new definition of the Folder. It must include the `name`
// field, which cannot be changed.
Folder *Folder `protobuf:"bytes,1,opt,name=folder,proto3" json:"folder,omitempty"`
// Required. Fields to be updated.
// Only the `display_name` can be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateFolderRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateFolderRequest.ProtoReflect.Descriptor instead.
func (x *UpdateFolderRequest) GetFolder() *Folder
func (x *UpdateFolderRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateFolderRequest) ProtoMessage()
func (x *UpdateFolderRequest) ProtoReflect() protoreflect.Message
func (x *UpdateFolderRequest) Reset()
func (x *UpdateFolderRequest) String() string
A status object which is used as the `metadata` field for the Operation returned by UpdateProject.
type UpdateProjectMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateProjectMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateProjectMetadata.ProtoReflect.Descriptor instead.
func (*UpdateProjectMetadata) ProtoMessage()
func (x *UpdateProjectMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateProjectMetadata) Reset()
func (x *UpdateProjectMetadata) String() string
The request sent to the [UpdateProject][google.cloud.resourcemanager.v3.Projects.UpdateProject] method.
Only the `display_name` and `labels` fields can be change. Use the [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method to change the `parent` field.
type UpdateProjectRequest struct {
// Required. The new definition of the project.
Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// Optional. An update mask to selectively update fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateProjectRequest.ProtoReflect.Descriptor instead.
func (x *UpdateProjectRequest) GetProject() *Project
func (x *UpdateProjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateProjectRequest) ProtoMessage()
func (x *UpdateProjectRequest) ProtoReflect() protoreflect.Message
func (x *UpdateProjectRequest) Reset()
func (x *UpdateProjectRequest) String() string
Runtime operation information for updating a TagKey.
type UpdateTagKeyMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateTagKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTagKeyMetadata.ProtoReflect.Descriptor instead.
func (*UpdateTagKeyMetadata) ProtoMessage()
func (x *UpdateTagKeyMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateTagKeyMetadata) Reset()
func (x *UpdateTagKeyMetadata) String() string
The request message for updating a TagKey.
type UpdateTagKeyRequest struct {
// Required. The new definition of the TagKey. Only the `description` and
// `etag` fields can be updated by this request. If the `etag` field is not
// empty, it must match the `etag` field of the existing tag key. Otherwise,
// `ABORTED` will be returned.
TagKey *TagKey `protobuf:"bytes,1,opt,name=tag_key,json=tagKey,proto3" json:"tag_key,omitempty"`
// Fields to be updated. The mask may only contain `description` or
// `etag`. If omitted entirely, both `description` and `etag` are assumed to
// be significant.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Set as true to perform validations necessary for updating the resource, but
// not actually perform the action.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateTagKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTagKeyRequest.ProtoReflect.Descriptor instead.
func (x *UpdateTagKeyRequest) GetTagKey() *TagKey
func (x *UpdateTagKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *UpdateTagKeyRequest) GetValidateOnly() bool
func (*UpdateTagKeyRequest) ProtoMessage()
func (x *UpdateTagKeyRequest) ProtoReflect() protoreflect.Message
func (x *UpdateTagKeyRequest) Reset()
func (x *UpdateTagKeyRequest) String() string
Runtime operation information for updating a TagValue.
type UpdateTagValueMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateTagValueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTagValueMetadata.ProtoReflect.Descriptor instead.
func (*UpdateTagValueMetadata) ProtoMessage()
func (x *UpdateTagValueMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateTagValueMetadata) Reset()
func (x *UpdateTagValueMetadata) String() string
The request message for updating a TagValue.
type UpdateTagValueRequest struct {
// Required. The new definition of the TagValue. Only fields `description` and
// `etag` fields can be updated by this request. If the `etag` field is
// nonempty, it must match the `etag` field of the existing ControlGroup.
// Otherwise, `ABORTED` will be returned.
TagValue *TagValue `protobuf:"bytes,1,opt,name=tag_value,json=tagValue,proto3" json:"tag_value,omitempty"`
// Optional. Fields to be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Optional. True to perform validations necessary for updating the resource,
// but not actually perform the action.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateTagValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTagValueRequest.ProtoReflect.Descriptor instead.
func (x *UpdateTagValueRequest) GetTagValue() *TagValue
func (x *UpdateTagValueRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *UpdateTagValueRequest) GetValidateOnly() bool
func (*UpdateTagValueRequest) ProtoMessage()
func (x *UpdateTagValueRequest) ProtoReflect() protoreflect.Message
func (x *UpdateTagValueRequest) Reset()
func (x *UpdateTagValueRequest) String() string