API documentation for resourcemanager_v3.types package.
Classes
CreateFolderMetadata
Metadata pertaining to the Folder creation process.
CreateFolderRequest
The CreateFolder request message.
CreateProjectMetadata
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.
CreateProjectRequest
The request sent to the CreateProject method.
CreateTagBindingMetadata
Runtime operation information for creating a TagValue.
CreateTagBindingRequest
The request message to create a TagBinding. .. attribute:: tag_binding
Required. The TagBinding to be created.
CreateTagKeyMetadata
Runtime operation information for creating a TagKey.
CreateTagKeyRequest
The request message for creating a TagKey. .. attribute:: tag_key
Required. The TagKey to be created. Only fields
short_name, description, and parent are
considered during the creation request.
CreateTagValueMetadata
Runtime operation information for creating a TagValue.
CreateTagValueRequest
The request message for creating a TagValue. .. attribute:: tag_value
Required. The TagValue to be created. Only fields
short_name, description, and parent are
considered during the creation request.
DeleteFolderMetadata
A status object which is used as the metadata field for the
Operation returned by DeleteFolder.
DeleteFolderRequest
The DeleteFolder request message.
DeleteOrganizationMetadata
A status object which is used as the metadata field for the
operation returned by DeleteOrganization.
DeleteProjectMetadata
A status object which is used as the metadata field for the
Operation returned by DeleteProject.
DeleteProjectRequest
DeleteProject method.
DeleteTagBindingMetadata
Runtime operation information for deleting a TagBinding.
DeleteTagBindingRequest
The request message to delete a TagBinding. .. attribute:: 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
DeleteTagKeyMetadata
Runtime operation information for deleting a TagKey.
DeleteTagKeyRequest
The request message for deleting a TagKey. .. attribute:: 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
DeleteTagValueMetadata
Runtime operation information for deleting a TagValue.
DeleteTagValueRequest
The request message for deleting a TagValue. .. attribute:: name
Required. Resource name for TagValue to be deleted in the format tagValues/456.
:type: str
Folder
A folder in an organization's resource hierarchy, used to organize that organization's resources.
GetFolderRequest
The GetFolder request message.
GetOrganizationRequest
The request sent to the GetOrganization method. The name
field is required. organization_id is no longer accepted.
GetProjectRequest
The request sent to the GetProject method.
GetTagKeyRequest
The request message for getting a TagKey. .. attribute:: name
Required. A resource name in the format tagKeys/{id},
such as tagKeys/123.
:type: str
GetTagValueRequest
The request message for getting a TagValue. .. attribute:: name
Required. Resource name for TagValue to be fetched in the
format tagValues/456.
:type: str
ListFoldersRequest
The ListFolders request message.
ListFoldersResponse
The ListFolders response message.
ListProjectsRequest
The request sent to the ListProjects method.
ListProjectsResponse
A page of the response received from the 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.
ListTagBindingsRequest
The request message to list all TagBindings for a parent. .. attribute:: 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
ListTagBindingsResponse
The ListTagBindings response. .. attribute:: tag_bindings
A possibly paginated list of TagBindings for the specified TagValue or resource.
:type: Sequence[google.cloud.resourcemanager_v3.types.TagBinding]
ListTagKeysRequest
The request message for listing all TagKeys under a parent resource.
ListTagKeysResponse
The ListTagKeys response message. .. attribute:: tag_keys
List of TagKeys that live under the specified parent in the request.
:type: Sequence[google.cloud.resourcemanager_v3.types.TagKey]
ListTagValuesRequest
The request message for listing TagValues for the specified TagKey.
ListTagValuesResponse
The ListTagValues response. .. attribute:: tag_values
A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey.
:type: Sequence[google.cloud.resourcemanager_v3.types.TagValue]
MoveFolderMetadata
Metadata pertaining to the folder move process.
MoveFolderRequest
The MoveFolder request message.
MoveProjectMetadata
A status object which is used as the metadata field for the
Operation returned by MoveProject.
MoveProjectRequest
The request sent to MoveProject method.
Organization
The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.
Project
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.
SearchFoldersRequest
The request message for searching folders.
SearchFoldersResponse
The response message for searching folders.
SearchOrganizationsRequest
The request sent to the SearchOrganizations method.
.. attribute:: page_size
Optional. The maximum number of organizations to return in the response. If unspecified, server picks an appropriate default.
:type: int
SearchOrganizationsResponse
The response returned from the SearchOrganizations method.
.. attribute:: organizations
The list of Organizations that matched the search query, possibly paginated.
:type: Sequence[google.cloud.resourcemanager_v3.types.Organization]
SearchProjectsRequest
The request sent to the SearchProjects method.
SearchProjectsResponse
A page of the response received from the 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.
TagBinding
A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.
TagKey
A TagKey, used to group a set of TagValues. .. attribute:: 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
TagValue
A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.
UndeleteFolderMetadata
A status object which is used as the metadata field for the
Operation returned by UndeleteFolder.
UndeleteFolderRequest
The UndeleteFolder request message.
UndeleteOrganizationMetadata
A status object which is used as the metadata field for the
Operation returned by UndeleteOrganization.
UndeleteProjectMetadata
A status object which is used as the metadata field for the
Operation returned by UndeleteProject.
UndeleteProjectRequest
The request sent to the [UndeleteProject] [google.cloud.resourcemanager.v3.Projects.UndeleteProject] method.
UpdateFolderMetadata
A status object which is used as the metadata field for the
Operation returned by UpdateFolder.
UpdateFolderRequest
The request sent to the UpdateFolder method.
Only the display_name field can be changed. All other fields
will be ignored. Use the
MoveFolder
method to change the parent field.
UpdateProjectMetadata
A status object which is used as the metadata field for the
Operation returned by UpdateProject.
UpdateProjectRequest
The request sent to the UpdateProject method.
Only the display_name and labels fields can be change. Use
the
MoveProject
method to change the parent field.
UpdateTagKeyMetadata
Runtime operation information for updating a TagKey.
UpdateTagKeyRequest
The request message for updating a TagKey. .. attribute:: 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,
FAILED_PRECONDITION will be returned.
UpdateTagValueMetadata
Runtime operation information for updating a TagValue.
UpdateTagValueRequest
The request message for updating a TagValue. .. attribute:: 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,
FAILED_PRECONDITION will be returned.