Class ResourcePoliciesClient (1.19.2) 

ResourcePoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.resource_policies.transports.base.ResourcePoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.resource_policies.transports.base.ResourcePoliciesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The ResourcePolicies API.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
ResourcePoliciesTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

ResourcePoliciesClient

ResourcePoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.resource_policies.transports.base.ResourcePoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.resource_policies.transports.base.ResourcePoliciesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the resource policies client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,ResourcePoliciesTransport,Callable[..., ResourcePoliciesTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ResourcePoliciesTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

aggregated_list

aggregated_list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AggregatedListResourcePoliciesRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.resource_policies.pagers.AggregatedListPager

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_aggregated_list():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListResourcePoliciesRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.AggregatedListResourcePoliciesRequest, dict]

The request object. A request message for ResourcePolicies.AggregatedList. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.compute_v1.services.resource_policies.pagers.AggregatedListPager Contains a list of resourcePolicies. Iterating over this object will yield results and resolve additional pages automatically.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

delete

delete(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Deletes the specified resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource_policy="resource_policy_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Delete. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy str

Name of the resource policy to delete. This corresponds to the resource_policy field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

delete_unary

delete_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Deletes the specified resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource_policy="resource_policy_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Delete. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy str

Name of the resource policy to delete. This corresponds to the resource_policy field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ResourcePoliciesClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
ResourcePoliciesClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ResourcePoliciesClient The constructed client.

get

get(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.ResourcePolicy

Retrieves all information of the specified resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.GetResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource_policy="resource_policy_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.GetResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Get. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy str

Name of the resource policy to retrieve. This corresponds to the resource_policy field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.compute_v1.types.ResourcePolicy Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetIamPolicyResourcePolicyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get_iam_policy():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.GetIamPolicyResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.GetIamPolicyResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.GetIamPolicy. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

The name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.compute_v1.types.Policy An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

insert

insert(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.ResourcePolicy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Creates a new resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.InsertResourcePolicyRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Insert. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy_resource google.cloud.compute_v1.types.ResourcePolicy

The body resource for this request This corresponds to the resource_policy_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

insert_unary

insert_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.ResourcePolicy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Creates a new resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.InsertResourcePolicyRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Insert. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy_resource google.cloud.compute_v1.types.ResourcePolicy

The body resource for this request This corresponds to the resource_policy_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

list

list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListResourcePoliciesRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.resource_policies.pagers.ListPager

A list all the resource policies that have been configured for the specified project in specified region.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.ListResourcePoliciesRequest(
        project="project_value",
        region="region_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.ListResourcePoliciesRequest, dict]

The request object. A request message for ResourcePolicies.List. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.compute_v1.services.resource_policies.pagers.ListPager Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

patch

patch(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.PatchResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy: typing.Optional[str] = None,
    resource_policy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.ResourcePolicy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Modify the specified resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.PatchResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource_policy="resource_policy_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.PatchResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Patch. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy str

Id of the resource policy to patch. This corresponds to the resource_policy field on the request instance; if request is provided, this should not be set.
resource_policy_resource google.cloud.compute_v1.types.ResourcePolicy

The body resource for this request This corresponds to the resource_policy_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

patch_unary

patch_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.PatchResourcePolicyRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource_policy: typing.Optional[str] = None,
    resource_policy_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.ResourcePolicy
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Modify the specified resource policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.PatchResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource_policy="resource_policy_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.PatchResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.Patch. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

Name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource_policy str

Id of the resource policy to patch. This corresponds to the resource_policy field on the request instance; if request is provided, this should not be set.
resource_policy_resource google.cloud.compute_v1.types.ResourcePolicy

The body resource for this request This corresponds to the resource_policy_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetIamPolicyResourcePolicyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    region_set_policy_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.RegionSetPolicyRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_iam_policy():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.SetIamPolicyResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetIamPolicyResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.SetIamPolicy. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

The name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
region_set_policy_request_resource google.cloud.compute_v1.types.RegionSetPolicyRequest

The body resource for this request This corresponds to the region_set_policy_request_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.compute_v1.types.Policy An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.TestIamPermissionsResourcePolicyRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    region: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    test_permissions_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TestPermissionsRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_test_iam_permissions():
    # Create a client
    client = compute_v1.ResourcePoliciesClient()

    # Initialize request argument(s)
    request = compute_v1.TestIamPermissionsResourcePolicyRequest(
        project="project_value",
        region="region_value",
        resource="resource_value",
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.TestIamPermissionsResourcePolicyRequest, dict]

The request object. A request message for ResourcePolicies.TestIamPermissions. See the method description for details.
project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
region str

The name of the region for this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.
resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
test_permissions_request_resource google.cloud.compute_v1.types.TestPermissionsRequest

The body resource for this request This corresponds to the test_permissions_request_resource field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.