As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Resourcemanager v3 API¶

class google.cloud.resourcemanager_v3.types.CreateFolderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metadata pertaining to the Folder creation process.

display_name¶

The display name of the folder.

Type: str

parent¶

The resource name of the folder or organization we are creating the folder under.

Type: str

class google.cloud.resourcemanager_v3.types.CreateFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The CreateFolder request message.

folder¶

Required. The folder being created, only the display name and parent will be consulted. All other fields will be ignored.

Type: google.cloud.resourcemanager_v3.types.Folder

class google.cloud.resourcemanager_v3.types.CreateProjectMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

create_time¶

Creation time of the project creation workflow.

Type: google.protobuf.timestamp_pb2.Timestamp

gettable¶

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.

Type: bool

ready¶

True if the project creation process is complete.

Type: bool

class google.cloud.resourcemanager_v3.types.CreateProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the [CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject] method.

project¶

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.

Type: google.cloud.resourcemanager_v3.types.Project

class google.cloud.resourcemanager_v3.types.CreateTagBindingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for creating a TagValue.

class google.cloud.resourcemanager_v3.types.CreateTagBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to create a TagBinding.

tag_binding¶

Required. The TagBinding to be created.

Type: google.cloud.resourcemanager_v3.types.TagBinding

validate_only¶

Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.CreateTagHoldMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for creating a TagHold. (– The metadata is currently empty, but may include information in the future. –)

class google.cloud.resourcemanager_v3.types.CreateTagHoldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to create a TagHold.

parent¶

Required. The resource name of the TagHold’s parent TagValue. Must be of the form: tagValues/{tag-value-id}.

Type: str

tag_hold¶

Required. The TagHold to be created.

Type: google.cloud.resourcemanager_v3.types.TagHold

validate_only¶

Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.CreateTagKeyMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for creating a TagKey.

class google.cloud.resourcemanager_v3.types.CreateTagKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for creating a TagKey.

tag_key¶

Required. The TagKey to be created. Only fields short_name, description, and parent are considered during the creation request.

Type: google.cloud.resourcemanager_v3.types.TagKey

validate_only¶

Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.CreateTagValueMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for creating a TagValue.

class google.cloud.resourcemanager_v3.types.CreateTagValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for creating a TagValue.

tag_value¶

Required. The TagValue to be created. Only fields short_name, description, and parent are considered during the creation request.

Type: google.cloud.resourcemanager_v3.types.TagValue

validate_only¶

Optional. Set as true to perform the validations necessary for creating the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.DeleteFolderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by DeleteFolder.

class google.cloud.resourcemanager_v3.types.DeleteFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The DeleteFolder request message.

name¶

Required. The resource name of the folder to be deleted. Must be of the form folders/{folder_id}.

Type: str

class google.cloud.resourcemanager_v3.types.DeleteOrganizationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the operation returned by DeleteOrganization.

class google.cloud.resourcemanager_v3.types.DeleteProjectMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by DeleteProject.

class google.cloud.resourcemanager_v3.types.DeleteProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

[DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject] method.

name¶

Required. The name of the Project (for example, projects/415104041262).

Type: str

class google.cloud.resourcemanager_v3.types.DeleteTagBindingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for deleting a TagBinding.

class google.cloud.resourcemanager_v3.types.DeleteTagBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to delete a TagBinding.

name¶

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

Type: str

class google.cloud.resourcemanager_v3.types.DeleteTagHoldMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for deleting a TagHold. (– The metadata is currently empty, but may include information in the future. –)

class google.cloud.resourcemanager_v3.types.DeleteTagHoldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to delete a TagHold.

name¶

Required. The resource name of the TagHold to delete. Must be of the form: tagValues/{tag-value-id}/tagHolds/{tag-hold-id}.

Type: str

validate_only¶

Optional. Set to true to perform the validations necessary for deleting the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.DeleteTagKeyMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for deleting a TagKey.

class google.cloud.resourcemanager_v3.types.DeleteTagKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for deleting a TagKey.

name¶

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.

Type: str

validate_only¶

Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.

Type: bool

etag¶

Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.

Type: str

class google.cloud.resourcemanager_v3.types.DeleteTagValueMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for deleting a TagValue.

class google.cloud.resourcemanager_v3.types.DeleteTagValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for deleting a TagValue.

name¶

Required. Resource name for TagValue to be deleted in the format tagValues/456.

Type: str

validate_only¶

Optional. Set as true to perform the validations necessary for deletion, but not actually perform the action.

Type: bool

etag¶

Optional. The etag known to the client for the expected state of the TagValue. This is to be used for optimistic concurrency.

Type: str

class google.cloud.resourcemanager_v3.types.EffectiveTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

tag_value¶

Resource name for TagValue in the format tagValues/456.

Type: str

namespaced_tag_value¶

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

Type: str

tag_key¶

The name of the TagKey, in the format tagKeys/{id}, such as tagKeys/123.

Type: str

namespaced_tag_key¶

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

Type: str

tag_key_parent_name¶

The parent name of the tag key. Must be in the format organizations/{organization_id} or projects/{project_number}

Type: str

inherited¶

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.

Type: bool

class google.cloud.resourcemanager_v3.types.Folder(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A folder in an organization’s resource hierarchy, used to organize that organization’s resources.

name¶

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: “folders/1234”.

Type: str

parent¶

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

Type: str

display_name¶

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}])?.

Type: str

state¶

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

Type: google.cloud.resourcemanager_v3.types.Folder.State

create_time¶

Output only. Timestamp when the folder was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Timestamp when the folder was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

delete_time¶

Output only. Timestamp when the folder was requested to be deleted.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

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.

Type: str

class State(value)[source]¶

Bases: proto.enums.Enum

Folder lifecycle states.

Values:

STATE_UNSPECIFIED (0):: Unspecified state.
ACTIVE (1):: The normal and active state.
DELETE_REQUESTED (2):: The folder has been marked for deletion by the user.

class google.cloud.resourcemanager_v3.types.GetFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The GetFolder request message.

name¶

Required. The resource name of the folder to retrieve. Must be of the form folders/{folder_id}.

Type: str

class google.cloud.resourcemanager_v3.types.GetNamespacedTagKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for getting a TagKey by its namespaced name.

name¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.GetNamespacedTagValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for getting a TagValue by its namespaced name.

name¶

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

Type: str

class google.cloud.resourcemanager_v3.types.GetOrganizationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the GetOrganization method. The name field is required. organization_id is no longer accepted.

name¶

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

Type: str

class google.cloud.resourcemanager_v3.types.GetProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.

name¶

Required. The name of the project (for example, projects/415104041262).

Type: str

class google.cloud.resourcemanager_v3.types.GetTagKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for getting a TagKey.

name¶

Required. A resource name in the format tagKeys/{id}, such as tagKeys/123.

Type: str

class google.cloud.resourcemanager_v3.types.GetTagValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for getting a TagValue.

name¶

Required. Resource name for TagValue to be fetched in the format tagValues/456.

Type: str

class google.cloud.resourcemanager_v3.types.ListEffectiveTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to ListEffectiveTags

parent¶

Required. The full resource name of a resource for which you want to list the effective tags. E.g. “//cloudresourcemanager.googleapis.com/projects/123”.

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListEffectiveTags that indicates from where this listing should continue.

Type: str

class google.cloud.resourcemanager_v3.types.ListEffectiveTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response of ListEffectiveTags.

effective_tags¶

A possibly paginated list of effective tags for the specified resource.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.EffectiveTag]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.ListFoldersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListFolders request message.

parent¶

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.

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

Type: str

show_deleted¶

Optional. Controls whether folders in the [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED] state should be returned. Defaults to false.

Type: bool

class google.cloud.resourcemanager_v3.types.ListFoldersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListFolders response message.

folders¶

A possibly paginated list of folders that are direct descendants of the specified parent resource.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.Folder]

next_page_token¶

A pagination token returned from a previous call to ListFolders that indicates from where listing should continue.

Type: str

class google.cloud.resourcemanager_v3.types.ListProjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.

parent¶

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

Type: str

page_token¶

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

Type: str

page_size¶

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.

Type: int

show_deleted¶

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

Type: bool

class google.cloud.resourcemanager_v3.types.ListProjectsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

projects¶

The list of Projects under the parent. This list can be paginated.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.Project]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to list all TagBindings for a parent.

parent¶

Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. “//cloudresourcemanager.googleapis.com/projects/123”.

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListTagBindings that indicates where this listing should continue from.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagBindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListTagBindings response.

tag_bindings¶

A possibly paginated list of TagBindings for the specified resource.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.TagBinding]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagHoldsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for listing the TagHolds under a TagValue.

parent¶

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}.

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListTagHolds that indicates where this listing should continue from.

Type: str

filter¶

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

Type: str

class google.cloud.resourcemanager_v3.types.ListTagHoldsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListTagHolds response.

tag_holds¶

A possibly paginated list of TagHolds.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.TagHold]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagKeysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for listing all TagKeys under a parent resource.

parent¶

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}

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListTagKey that indicates where this listing should continue from.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagKeysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListTagKeys response message.

tag_keys¶

List of TagKeys that live under the specified parent in the request.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.TagKey]

next_page_token¶

A pagination token returned from a previous call to ListTagKeys that indicates from where listing should continue.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagValuesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

parent¶

Required.

Type: str

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to ListTagValues that indicates where this listing should continue from.

Type: str

class google.cloud.resourcemanager_v3.types.ListTagValuesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The ListTagValues response.

tag_values¶

A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.TagValue]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.MoveFolderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metadata pertaining to the folder move process.

display_name¶

The display name of the folder.

Type: str

source_parent¶

The resource name of the folder’s parent.

Type: str

destination_parent¶

The resource name of the folder or organization to move the folder to.

Type: str

class google.cloud.resourcemanager_v3.types.MoveFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The MoveFolder request message.

name¶

Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}

Type: str

destination_parent¶

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

Type: str

class google.cloud.resourcemanager_v3.types.MoveProjectMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by MoveProject.

class google.cloud.resourcemanager_v3.types.MoveProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method.

name¶

Required. The name of the project to move.

Type: str

destination_parent¶

Required. The new parent to move the Project under.

Type: str

class google.cloud.resourcemanager_v3.types.Organization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The root node in the resource hierarchy to which a particular entity’s (a company, for example) resources belong.

name¶

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

Type: str

display_name¶

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.

Type: str

directory_customer_id¶

Immutable. The G Suite / Workspace customer id used in the Directory API.

This field is a member of oneof owner.

Type: str

state¶

Output only. The organization’s current lifecycle state.

Type: google.cloud.resourcemanager_v3.types.Organization.State

create_time¶

Output only. Timestamp when the Organization was created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Timestamp when the Organization was last modified.

Type: google.protobuf.timestamp_pb2.Timestamp

delete_time¶

Output only. Timestamp when the Organization was requested for deletion.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

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.

Type: str

class State(value)[source]¶

Bases: proto.enums.Enum

Organization lifecycle states.

Values:

STATE_UNSPECIFIED (0):: Unspecified state. This is only useful for distinguishing unset values.
ACTIVE (1):: The normal and active state.
DELETE_REQUESTED (2):: The organization has been marked for deletion by the user.

class google.cloud.resourcemanager_v3.types.Project(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

Output only. The unique resource name of the project. It is an int64 generated number prefixed by “projects/”.

Example: projects/415104041262

Type: str

parent¶

Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.

Type: str

project_id¶

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

Type: str

state¶

Output only. The project lifecycle state.

Type: google.cloud.resourcemanager_v3.types.Project.State

display_name¶

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

Type: str

create_time¶

Output only. Creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. The most recent time this resource was modified.

Type: google.protobuf.timestamp_pb2.Timestamp

delete_time¶

Output only. The time at which this resource was requested for deletion.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

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.

Type: str

labels¶

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"

Type: MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class State(value)[source]¶

Bases: proto.enums.Enum

Project lifecycle states.

Values:

STATE_UNSPECIFIED (0):: Unspecified state. This is only used/useful for distinguishing unset values.
ACTIVE (1):: The normal and active state.
DELETE_REQUESTED (2):: 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].

class google.cloud.resourcemanager_v3.types.Purpose(value)[source]¶

Bases: proto.enums.Enum

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.

Values:

PURPOSE_UNSPECIFIED (0):

Unspecified purpose.

GCE_FIREWALL (1):

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

class google.cloud.resourcemanager_v3.types.SearchFoldersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for searching folders.

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.

Type: str

query¶

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

Type: str

class google.cloud.resourcemanager_v3.types.SearchFoldersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response message for searching folders.

folders¶

A possibly paginated folder search results. the specified parent resource.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.Folder]

next_page_token¶

A pagination token returned from a previous call to SearchFolders that indicates from where searching should continue.

Type: str

class google.cloud.resourcemanager_v3.types.SearchOrganizationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the SearchOrganizations method.

page_size¶

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.

Type: int

page_token¶

Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.

Type: str

query¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.SearchOrganizationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response returned from the SearchOrganizations method.

organizations¶

The list of Organizations that matched the search query, possibly paginated.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.Organization]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.SearchProjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.

query¶

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.

Type: str

page_token¶

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

Type: str

page_size¶

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.

Type: int

class google.cloud.resourcemanager_v3.types.SearchProjectsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

projects¶

The list of Projects that matched the list filter query. This list can be paginated.

Type: MutableSequence[google.cloud.resourcemanager_v3.types.Project]

next_page_token¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.TagBinding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

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

Type: str

parent¶

The full resource name of the resource the TagValue is bound to. E.g. //cloudresourcemanager.googleapis.com/projects/123

Type: str

tag_value¶

The TagValue of the TagBinding. Must be of the form tagValues/456.

Type: str

tag_value_namespaced_name¶

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.

Type: str

class google.cloud.resourcemanager_v3.types.TagHold(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

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.

Type: str

holder¶

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

Type: str

origin¶

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

Type: str

help_link¶

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

Type: str

create_time¶

Output only. The time this TagHold was created.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.resourcemanager_v3.types.TagKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A TagKey, used to group a set of TagValues.

name¶

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.

Type: str

parent¶

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

Type: str

short_name¶

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.

Type: str

namespaced_name¶

Output only. Immutable. Namespaced name of the TagKey.

Type: str

description¶

Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

Read-write.

Type: str

create_time¶

Output only. Creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Update time.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

Type: str

purpose¶

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.

Type: google.cloud.resourcemanager_v3.types.Purpose

purpose_data¶

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.

Type: MutableMapping[str, str]

class PurposeDataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.resourcemanager_v3.types.TagValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.

name¶

Immutable. Resource name for TagValue in the format tagValues/456.

Type: str

parent¶

Immutable. The resource name of the new TagValue’s parent TagKey. Must be of the form tagKeys/{tag_key_id}.

Type: str

short_name¶

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.

Type: str

namespaced_name¶

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

Type: str

description¶

Optional. User-assigned description of the TagValue. Must not exceed 256 characters.

Read-write.

Type: str

create_time¶

Output only. Creation time.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Update time.

Type: google.protobuf.timestamp_pb2.Timestamp

etag¶

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details.

Type: str

class google.cloud.resourcemanager_v3.types.UndeleteFolderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by UndeleteFolder.

class google.cloud.resourcemanager_v3.types.UndeleteFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The UndeleteFolder request message.

name¶

Required. The resource name of the folder to undelete. Must be of the form folders/{folder_id}.

Type: str

class google.cloud.resourcemanager_v3.types.UndeleteOrganizationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by UndeleteOrganization.

class google.cloud.resourcemanager_v3.types.UndeleteProjectMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by UndeleteProject.

class google.cloud.resourcemanager_v3.types.UndeleteProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request sent to the [UndeleteProject] [google.cloud.resourcemanager.v3.Projects.UndeleteProject] method.

name¶

Required. The name of the project (for example, projects/415104041262).

Required.

Type: str

class google.cloud.resourcemanager_v3.types.UpdateFolderMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by UpdateFolder.

class google.cloud.resourcemanager_v3.types.UpdateFolderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

folder¶

Required. The new definition of the Folder. It must include the name field, which cannot be changed.

Type: google.cloud.resourcemanager_v3.types.Folder

update_mask¶

Required. Fields to be updated. Only the display_name can be updated.

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.resourcemanager_v3.types.UpdateProjectMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A status object which is used as the metadata field for the Operation returned by UpdateProject.

class google.cloud.resourcemanager_v3.types.UpdateProjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

project¶

Required. The new definition of the project.

Type: google.cloud.resourcemanager_v3.types.Project

update_mask¶

Optional. An update mask to selectively update fields.

Type: google.protobuf.field_mask_pb2.FieldMask

class google.cloud.resourcemanager_v3.types.UpdateTagKeyMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for updating a TagKey.

class google.cloud.resourcemanager_v3.types.UpdateTagKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for updating a TagKey.

tag_key¶

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.

Type: google.cloud.resourcemanager_v3.types.TagKey

update_mask¶

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.

Type: google.protobuf.field_mask_pb2.FieldMask

validate_only¶

Set as true to perform validations necessary for updating the resource, but not actually perform the action.

Type: bool

class google.cloud.resourcemanager_v3.types.UpdateTagValueMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Runtime operation information for updating a TagValue.

class google.cloud.resourcemanager_v3.types.UpdateTagValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for updating a TagValue.

tag_value¶

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.

Type: google.cloud.resourcemanager_v3.types.TagValue

update_mask¶

Optional. Fields to be updated.

Type: google.protobuf.field_mask_pb2.FieldMask

validate_only¶

Optional. True to perform validations necessary for updating the resource, but not actually perform the action.

Type: bool

Types for Google Cloud Resourcemanager v3 API¶

google-cloud-resource-manager

Navigation

Related Topics