Package Classes (1.13.0)

Summary of entries of Classes for cloudresourcemanager.

Classes

FoldersAsyncClient

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersClient

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

ListFoldersAsyncPager

A pager for iterating through list_folders requests.

This class thinly wraps an initial ListFoldersResponse object, and provides an __aiter__ method to iterate through its folders field.

If there are more pages, the __aiter__ method will make additional ListFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual ListFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFoldersPager

A pager for iterating through list_folders requests.

This class thinly wraps an initial ListFoldersResponse object, and provides an __iter__ method to iterate through its folders field.

If there are more pages, the __iter__ method will make additional ListFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual ListFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchFoldersAsyncPager

A pager for iterating through search_folders requests.

This class thinly wraps an initial SearchFoldersResponse object, and provides an __aiter__ method to iterate through its folders field.

If there are more pages, the __aiter__ method will make additional SearchFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual SearchFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchFoldersPager

A pager for iterating through search_folders requests.

This class thinly wraps an initial SearchFoldersResponse object, and provides an __iter__ method to iterate through its folders field.

If there are more pages, the __iter__ method will make additional SearchFolders requests and continue to iterate through the folders field on the corresponding responses.

All the usual SearchFoldersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

OrganizationsAsyncClient

Allows users to manage their organization resources.

OrganizationsClient

Allows users to manage their organization resources.

SearchOrganizationsAsyncPager

A pager for iterating through search_organizations requests.

This class thinly wraps an initial SearchOrganizationsResponse object, and provides an __aiter__ method to iterate through its organizations field.

If there are more pages, the __aiter__ method will make additional SearchOrganizations requests and continue to iterate through the organizations field on the corresponding responses.

All the usual SearchOrganizationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchOrganizationsPager

A pager for iterating through search_organizations requests.

This class thinly wraps an initial SearchOrganizationsResponse object, and provides an __iter__ method to iterate through its organizations field.

If there are more pages, the __iter__ method will make additional SearchOrganizations requests and continue to iterate through the organizations field on the corresponding responses.

All the usual SearchOrganizationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProjectsAsyncPager

A pager for iterating through list_projects requests.

This class thinly wraps an initial ListProjectsResponse object, and provides an __aiter__ method to iterate through its projects field.

If there are more pages, the __aiter__ method will make additional ListProjects requests and continue to iterate through the projects field on the corresponding responses.

All the usual ListProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProjectsPager

A pager for iterating through list_projects requests.

This class thinly wraps an initial ListProjectsResponse object, and provides an __iter__ method to iterate through its projects field.

If there are more pages, the __iter__ method will make additional ListProjects requests and continue to iterate through the projects field on the corresponding responses.

All the usual ListProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchProjectsAsyncPager

A pager for iterating through search_projects requests.

This class thinly wraps an initial SearchProjectsResponse object, and provides an __aiter__ method to iterate through its projects field.

If there are more pages, the __aiter__ method will make additional SearchProjects requests and continue to iterate through the projects field on the corresponding responses.

All the usual SearchProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchProjectsPager

A pager for iterating through search_projects requests.

This class thinly wraps an initial SearchProjectsResponse object, and provides an __iter__ method to iterate through its projects field.

If there are more pages, the __iter__ method will make additional SearchProjects requests and continue to iterate through the projects field on the corresponding responses.

All the usual SearchProjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TagBindingsAsyncClient

Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.

TagBindingsClient

Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.

ListEffectiveTagsAsyncPager

A pager for iterating through list_effective_tags requests.

This class thinly wraps an initial ListEffectiveTagsResponse object, and provides an __aiter__ method to iterate through its effective_tags field.

If there are more pages, the __aiter__ method will make additional ListEffectiveTags requests and continue to iterate through the effective_tags field on the corresponding responses.

All the usual ListEffectiveTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEffectiveTagsPager

A pager for iterating through list_effective_tags requests.

This class thinly wraps an initial ListEffectiveTagsResponse object, and provides an __iter__ method to iterate through its effective_tags field.

If there are more pages, the __iter__ method will make additional ListEffectiveTags requests and continue to iterate through the effective_tags field on the corresponding responses.

All the usual ListEffectiveTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTagBindingsAsyncPager

A pager for iterating through list_tag_bindings requests.

This class thinly wraps an initial ListTagBindingsResponse object, and provides an __aiter__ method to iterate through its tag_bindings field.

If there are more pages, the __aiter__ method will make additional ListTagBindings requests and continue to iterate through the tag_bindings field on the corresponding responses.

All the usual ListTagBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTagBindingsPager

A pager for iterating through list_tag_bindings requests.

This class thinly wraps an initial ListTagBindingsResponse object, and provides an __iter__ method to iterate through its tag_bindings field.

If there are more pages, the __iter__ method will make additional ListTagBindings requests and continue to iterate through the tag_bindings field on the corresponding responses.

All the usual ListTagBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Allow users to create and manage TagHolds for TagValues. TagHolds represent the use of a Tag Value that is not captured by TagBindings but should still block TagValue deletion (such as a reference in a policy condition). This service provides isolated failure domains by cloud location so that TagHolds can be managed in the same location as their usage.

TagHoldsClient

ListTagHoldsAsyncPager

A pager for iterating through list_tag_holds requests.

This class thinly wraps an initial ListTagHoldsResponse object, and provides an __aiter__ method to iterate through its tag_holds field.

If there are more pages, the __aiter__ method will make additional ListTagHolds requests and continue to iterate through the tag_holds field on the corresponding responses.

All the usual ListTagHoldsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTagHoldsPager

A pager for iterating through list_tag_holds requests.

This class thinly wraps an initial ListTagHoldsResponse object, and provides an __iter__ method to iterate through its tag_holds field.

If there are more pages, the __iter__ method will make additional ListTagHolds requests and continue to iterate through the tag_holds field on the corresponding responses.

All the usual ListTagHoldsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TagKeysAsyncClient

Allow users to create and manage tag keys.

TagKeysClient

Allow users to create and manage tag keys.

ListTagKeysAsyncPager

A pager for iterating through list_tag_keys requests.

This class thinly wraps an initial ListTagKeysResponse object, and provides an __aiter__ method to iterate through its tag_keys field.

If there are more pages, the __aiter__ method will make additional ListTagKeys requests and continue to iterate through the tag_keys field on the corresponding responses.

All the usual ListTagKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTagKeysPager

A pager for iterating through list_tag_keys requests.

This class thinly wraps an initial ListTagKeysResponse object, and provides an __iter__ method to iterate through its tag_keys field.

If there are more pages, the __iter__ method will make additional ListTagKeys requests and continue to iterate through the tag_keys field on the corresponding responses.

All the usual ListTagKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TagValuesAsyncClient

Allow users to create and manage tag values.

TagValuesClient

Allow users to create and manage tag values.

ListTagValuesAsyncPager

A pager for iterating through list_tag_values requests.

This class thinly wraps an initial ListTagValuesResponse object, and provides an __aiter__ method to iterate through its tag_values field.

If there are more pages, the __aiter__ method will make additional ListTagValues requests and continue to iterate through the tag_values field on the corresponding responses.

All the usual ListTagValuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTagValuesPager

A pager for iterating through list_tag_values requests.

This class thinly wraps an initial ListTagValuesResponse object, and provides an __iter__ method to iterate through its tag_values field.

If there are more pages, the __iter__ method will make additional ListTagValues requests and continue to iterate through the tag_values field on the corresponding responses.

All the usual ListTagValuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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.

CreateTagHoldMetadata

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

CreateTagHoldRequest

The request message to create a TagHold.

CreateTagKeyMetadata

Runtime operation information for creating a TagKey.

CreateTagKeyRequest

The request message for creating a TagKey.

CreateTagValueMetadata

Runtime operation information for creating a TagValue.

CreateTagValueRequest

The request message for creating a TagValue.

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.

DeleteTagHoldMetadata

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

DeleteTagHoldRequest

The request message to delete a TagHold.

DeleteTagKeyMetadata

Runtime operation information for deleting a TagKey.

DeleteTagKeyRequest

The request message for deleting a TagKey.

DeleteTagValueMetadata

Runtime operation information for deleting a TagValue.

DeleteTagValueRequest

The request message for deleting a TagValue.

EffectiveTag

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.

Folder

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

State

Folder lifecycle states.

GetFolderRequest

The GetFolder request message.

GetNamespacedTagKeyRequest

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

GetNamespacedTagValueRequest

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

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.

GetTagValueRequest

The request message for getting a TagValue.

ListEffectiveTagsRequest

The request message to ListEffectiveTags

ListEffectiveTagsResponse

The response of ListEffectiveTags.

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.

ListTagBindingsResponse

The ListTagBindings response.

ListTagHoldsRequest

The request message for listing the TagHolds under a TagValue.

ListTagHoldsResponse

The ListTagHolds response.

ListTagKeysRequest

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

ListTagKeysResponse

The ListTagKeys response message.

ListTagValuesRequest

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.

ListTagValuesResponse

The ListTagValues response.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Organization lifecycle states.

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.

LabelsEntry

The abstract base class for a message.

State

Project lifecycle states.

Purpose

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.

    -

    `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`

Package Classes (1.13.0)

Classes

Modules