Class ProjectsClient (1.9.0)

ProjectsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport]] = None, client_options: Optional[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 Projects API.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
ProjectsTransportThe transport used by the client instance.

Methods

ProjectsClient

ProjectsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport]] = None, client_options: Optional[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 projects client.

Parameters
NameDescription
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 Union[str, ProjectsTransport]

The transport to use. 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. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

disable_xpn_host

disable_xpn_host(request: Optional[Union[google.cloud.compute_v1.types.compute.DisableXpnHostProjectRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Disable this project as a shared VPC host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DisableXpnHostProjectRequest, dict]

The request object. A request message for Projects.DisableXpnHost. 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

disable_xpn_host_unary

disable_xpn_host_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DisableXpnHostProjectRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Disable this project as a shared VPC host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DisableXpnHostProjectRequest, dict]

The request object. A request message for Projects.DisableXpnHost. 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

disable_xpn_resource

disable_xpn_resource(request: Optional[Union[google.cloud.compute_v1.types.compute.DisableXpnResourceProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_disable_xpn_resource_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsDisableXpnResourceRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Disable a service resource (also known as service project) associated with this host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DisableXpnResourceProjectRequest, dict]

The request object. A request message for Projects.DisableXpnResource. 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.

projects_disable_xpn_resource_request_resource google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest

The body resource for this request This corresponds to the projects_disable_xpn_resource_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

disable_xpn_resource_unary

disable_xpn_resource_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DisableXpnResourceProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_disable_xpn_resource_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsDisableXpnResourceRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Disable a service resource (also known as service project) associated with this host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DisableXpnResourceProjectRequest, dict]

The request object. A request message for Projects.DisableXpnResource. 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.

projects_disable_xpn_resource_request_resource google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest

The body resource for this request This corresponds to the projects_disable_xpn_resource_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

enable_xpn_host

enable_xpn_host(request: Optional[Union[google.cloud.compute_v1.types.compute.EnableXpnHostProjectRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enable this project as a shared VPC host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.EnableXpnHostProjectRequest, dict]

The request object. A request message for Projects.EnableXpnHost. 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

enable_xpn_host_unary

enable_xpn_host_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.EnableXpnHostProjectRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enable this project as a shared VPC host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.EnableXpnHostProjectRequest, dict]

The request object. A request message for Projects.EnableXpnHost. 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

enable_xpn_resource

enable_xpn_resource(request: Optional[Union[google.cloud.compute_v1.types.compute.EnableXpnResourceProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_enable_xpn_resource_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsEnableXpnResourceRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.EnableXpnResourceProjectRequest, dict]

The request object. A request message for Projects.EnableXpnResource. 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.

projects_enable_xpn_resource_request_resource google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest

The body resource for this request This corresponds to the projects_enable_xpn_resource_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

enable_xpn_resource_unary

enable_xpn_resource_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.EnableXpnResourceProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_enable_xpn_resource_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsEnableXpnResourceRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.EnableXpnResourceProjectRequest, dict]

The request object. A request message for Projects.EnableXpnResource. 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.

projects_enable_xpn_resource_request_resource google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest

The body resource for this request This corresponds to the projects_enable_xpn_resource_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ProjectsClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
ProjectsClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ProjectsClientThe constructed client.

get

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

Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetProjectRequest, dict]

The request object. A request message for Projects.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.

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
TypeDescription
google.cloud.compute_v1.types.ProjectRepresents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.

get_mtls_endpoint_and_cert_source

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

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
NameDescription
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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_xpn_host

get_xpn_host(request: Optional[Union[google.cloud.compute_v1.types.compute.GetXpnHostProjectRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets the shared VPC host project that this project links to. May be empty if no link exists.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetXpnHostProjectRequest, dict]

The request object. A request message for Projects.GetXpnHost. 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
TypeDescription
google.cloud.compute_v1.types.ProjectRepresents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.

get_xpn_resources

get_xpn_resources(request: Optional[Union[google.cloud.compute_v1.types.compute.GetXpnResourcesProjectsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets service resources (a.k.a service project) associated with this host project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetXpnResourcesProjectsRequest, dict]

The request object. A request message for Projects.GetXpnResources. 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
TypeDescription
google.cloud.compute_v1.services.projects.pagers.GetXpnResourcesPagerIterating over this object will yield results and resolve additional pages automatically.

list_xpn_hosts

list_xpn_hosts(request: Optional[Union[google.cloud.compute_v1.types.compute.ListXpnHostsProjectsRequest, dict]] = None, *, project: Optional[str] = None, projects_list_xpn_hosts_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsListXpnHostsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Lists all shared VPC host projects visible to the user in an organization.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ListXpnHostsProjectsRequest, dict]

The request object. A request message for Projects.ListXpnHosts. 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.

projects_list_xpn_hosts_request_resource google.cloud.compute_v1.types.ProjectsListXpnHostsRequest

The body resource for this request This corresponds to the projects_list_xpn_hosts_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
TypeDescription
google.cloud.compute_v1.services.projects.pagers.ListXpnHostsPagerIterating over this object will yield results and resolve additional pages automatically.

move_disk

move_disk(request: Optional[Union[google.cloud.compute_v1.types.compute.MoveDiskProjectRequest, dict]] = None, *, project: Optional[str] = None, disk_move_request_resource: Optional[google.cloud.compute_v1.types.compute.DiskMoveRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Moves a persistent disk from one zone to another.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.MoveDiskProjectRequest, dict]

The request object. A request message for Projects.MoveDisk. 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.

disk_move_request_resource google.cloud.compute_v1.types.DiskMoveRequest

The body resource for this request This corresponds to the disk_move_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

move_disk_unary

move_disk_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.MoveDiskProjectRequest, dict]] = None, *, project: Optional[str] = None, disk_move_request_resource: Optional[google.cloud.compute_v1.types.compute.DiskMoveRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Moves a persistent disk from one zone to another.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.MoveDiskProjectRequest, dict]

The request object. A request message for Projects.MoveDisk. 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.

disk_move_request_resource google.cloud.compute_v1.types.DiskMoveRequest

The body resource for this request This corresponds to the disk_move_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

move_instance

move_instance(request: Optional[Union[google.cloud.compute_v1.types.compute.MoveInstanceProjectRequest, dict]] = None, *, project: Optional[str] = None, instance_move_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceMoveRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Moves an instance and its attached persistent disks from one zone to another. Note: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the known issue </compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior>__.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.MoveInstanceProjectRequest, dict]

The request object. A request message for Projects.MoveInstance. 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.

instance_move_request_resource google.cloud.compute_v1.types.InstanceMoveRequest

The body resource for this request This corresponds to the instance_move_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

move_instance_unary

move_instance_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.MoveInstanceProjectRequest, dict]] = None, *, project: Optional[str] = None, instance_move_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceMoveRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Moves an instance and its attached persistent disks from one zone to another. Note: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the known issue </compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior>__.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.MoveInstanceProjectRequest, dict]

The request object. A request message for Projects.MoveInstance. 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.

instance_move_request_resource google.cloud.compute_v1.types.InstanceMoveRequest

The body resource for this request This corresponds to the instance_move_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

set_common_instance_metadata

set_common_instance_metadata(request: Optional[Union[google.cloud.compute_v1.types.compute.SetCommonInstanceMetadataProjectRequest, dict]] = None, *, project: Optional[str] = None, metadata_resource: Optional[google.cloud.compute_v1.types.compute.Metadata] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets metadata common to all instances within the specified project using the data included in the request.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetCommonInstanceMetadataProjectRequest, dict]

The request object. A request message for Projects.SetCommonInstanceMetadata. 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.

metadata_resource google.cloud.compute_v1.types.Metadata

The body resource for this request This corresponds to the metadata_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_common_instance_metadata_unary

set_common_instance_metadata_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetCommonInstanceMetadataProjectRequest, dict]] = None, *, project: Optional[str] = None, metadata_resource: Optional[google.cloud.compute_v1.types.compute.Metadata] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets metadata common to all instances within the specified project using the data included in the request.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetCommonInstanceMetadataProjectRequest, dict]

The request object. A request message for Projects.SetCommonInstanceMetadata. 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.

metadata_resource google.cloud.compute_v1.types.Metadata

The body resource for this request This corresponds to the metadata_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_default_network_tier

set_default_network_tier(request: Optional[Union[google.cloud.compute_v1.types.compute.SetDefaultNetworkTierProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_set_default_network_tier_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsSetDefaultNetworkTierRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetDefaultNetworkTierProjectRequest, dict]

The request object. A request message for Projects.SetDefaultNetworkTier. 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.

projects_set_default_network_tier_request_resource google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest

The body resource for this request This corresponds to the projects_set_default_network_tier_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_default_network_tier_unary

set_default_network_tier_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetDefaultNetworkTierProjectRequest, dict]] = None, *, project: Optional[str] = None, projects_set_default_network_tier_request_resource: Optional[google.cloud.compute_v1.types.compute.ProjectsSetDefaultNetworkTierRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetDefaultNetworkTierProjectRequest, dict]

The request object. A request message for Projects.SetDefaultNetworkTier. 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.

projects_set_default_network_tier_request_resource google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest

The body resource for this request This corresponds to the projects_set_default_network_tier_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_usage_export_bucket

set_usage_export_bucket(request: Optional[Union[google.cloud.compute_v1.types.compute.SetUsageExportBucketProjectRequest, dict]] = None, *, project: Optional[str] = None, usage_export_location_resource: Optional[google.cloud.compute_v1.types.compute.UsageExportLocation] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetUsageExportBucketProjectRequest, dict]

The request object. A request message for Projects.SetUsageExportBucket. 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.

usage_export_location_resource google.cloud.compute_v1.types.UsageExportLocation

The body resource for this request This corresponds to the usage_export_location_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_usage_export_bucket_unary

set_usage_export_bucket_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetUsageExportBucketProjectRequest, dict]] = None, *, project: Optional[str] = None, usage_export_location_resource: Optional[google.cloud.compute_v1.types.compute.UsageExportLocation] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetUsageExportBucketProjectRequest, dict]

The request object. A request message for Projects.SetUsageExportBucket. 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.

usage_export_location_resource google.cloud.compute_v1.types.UsageExportLocation

The body resource for this request This corresponds to the usage_export_location_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.