ProjectsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport, typing.Callable[[...], google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport]]] = 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 Projects 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 |
ProjectsTransport |
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
ProjectsClient
ProjectsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport, typing.Callable[[...], google.cloud.compute_v1.services.projects.transports.base.ProjectsTransport]]] = 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 projects 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,ProjectsTransport,Callable[..., ProjectsTransport]]]
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 ProjectsTransport 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 |
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 |
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.
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.
disable_xpn_host
disable_xpn_host(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DisableXpnHostProjectRequest, 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.api_core.extended_operation.ExtendedOperation
Disable this project as a shared VPC host project.
# 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_disable_xpn_host():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.DisableXpnHostProjectRequest(
project="project_value",
)
# Make the request
response = client.disable_xpn_host(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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. |
disable_xpn_host_unary
disable_xpn_host_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DisableXpnHostProjectRequest, 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.types.compute.Operation
Disable this project as a shared VPC host project.
# 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_disable_xpn_host():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.DisableXpnHostProjectRequest(
project="project_value",
)
# Make the request
response = client.disable_xpn_host(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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. |
disable_xpn_resource
disable_xpn_resource(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DisableXpnResourceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_disable_xpn_resource_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsDisableXpnResourceRequest
] = 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
Disable a service resource (also known as service project) associated with this host project.
# 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_disable_xpn_resource():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.DisableXpnResourceProjectRequest(
project="project_value",
)
# Make the request
response = client.disable_xpn_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_disable_xpn_resource_request_resource |
google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest
The body resource for this request This corresponds to the |
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. |
disable_xpn_resource_unary
disable_xpn_resource_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DisableXpnResourceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_disable_xpn_resource_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsDisableXpnResourceRequest
] = 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
Disable a service resource (also known as service project) associated with this host project.
# 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_disable_xpn_resource():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.DisableXpnResourceProjectRequest(
project="project_value",
)
# Make the request
response = client.disable_xpn_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_disable_xpn_resource_request_resource |
google.cloud.compute_v1.types.ProjectsDisableXpnResourceRequest
The body resource for this request This corresponds to the |
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. |
enable_xpn_host
enable_xpn_host(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.EnableXpnHostProjectRequest, 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.api_core.extended_operation.ExtendedOperation
Enable this project as a shared VPC host project.
# 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_enable_xpn_host():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.EnableXpnHostProjectRequest(
project="project_value",
)
# Make the request
response = client.enable_xpn_host(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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. |
enable_xpn_host_unary
enable_xpn_host_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.EnableXpnHostProjectRequest, 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.types.compute.Operation
Enable this project as a shared VPC host project.
# 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_enable_xpn_host():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.EnableXpnHostProjectRequest(
project="project_value",
)
# Make the request
response = client.enable_xpn_host(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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. |
enable_xpn_resource
enable_xpn_resource(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.EnableXpnResourceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_enable_xpn_resource_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsEnableXpnResourceRequest
] = 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
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.
# 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_enable_xpn_resource():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.EnableXpnResourceProjectRequest(
project="project_value",
)
# Make the request
response = client.enable_xpn_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_enable_xpn_resource_request_resource |
google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest
The body resource for this request This corresponds to the |
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. |
enable_xpn_resource_unary
enable_xpn_resource_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.EnableXpnResourceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_enable_xpn_resource_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsEnableXpnResourceRequest
] = 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
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.
# 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_enable_xpn_resource():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.EnableXpnResourceProjectRequest(
project="project_value",
)
# Make the request
response = client.enable_xpn_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_enable_xpn_resource_request_resource |
google.cloud.compute_v1.types.ProjectsEnableXpnResourceRequest
The body resource for this request This corresponds to the |
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 |
ProjectsClient |
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 |
ProjectsClient |
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 |
ProjectsClient |
The constructed client. |
get
get(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.GetProjectRequest, 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.types.compute.Project
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.
# 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.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.GetProjectRequest(
project="project_value",
)
# Make the request
response = client.get(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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.Project |
Represents 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: 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 |
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. |
get_xpn_host
get_xpn_host(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetXpnHostProjectRequest, 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.types.compute.Project
Gets the shared VPC host project that this project links to. May be empty if no link 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_xpn_host():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.GetXpnHostProjectRequest(
project="project_value",
)
# Make the request
response = client.get_xpn_host(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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.Project |
Represents 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: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetXpnResourcesProjectsRequest, 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.projects.pagers.GetXpnResourcesPager
Gets service resources (a.k.a service project) associated with this host project.
# 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_xpn_resources():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.GetXpnResourcesProjectsRequest(
project="project_value",
)
# Make the request
page_result = client.get_xpn_resources(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
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 |
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.projects.pagers.GetXpnResourcesPager |
Iterating over this object will yield results and resolve additional pages automatically. |
list_xpn_hosts
list_xpn_hosts(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListXpnHostsProjectsRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_list_xpn_hosts_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsListXpnHostsRequest
] = 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.projects.pagers.ListXpnHostsPager
Lists all shared VPC host projects visible to the user in an organization.
# 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_xpn_hosts():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.ListXpnHostsProjectsRequest(
project="project_value",
)
# Make the request
page_result = client.list_xpn_hosts(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_list_xpn_hosts_request_resource |
google.cloud.compute_v1.types.ProjectsListXpnHostsRequest
The body resource for this request This corresponds to the |
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.projects.pagers.ListXpnHostsPager |
Iterating over this object will yield results and resolve additional pages automatically. |
move_disk
move_disk(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.MoveDiskProjectRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
disk_move_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.DiskMoveRequest
] = 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
Moves a persistent disk from one zone to another.
# 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_move_disk():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.MoveDiskProjectRequest(
project="project_value",
)
# Make the request
response = client.move_disk(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
disk_move_request_resource |
google.cloud.compute_v1.types.DiskMoveRequest
The body resource for this request This corresponds to the |
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. |
move_disk_unary
move_disk_unary(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.MoveDiskProjectRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
disk_move_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.DiskMoveRequest
] = 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
Moves a persistent disk from one zone to another.
# 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_move_disk():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.MoveDiskProjectRequest(
project="project_value",
)
# Make the request
response = client.move_disk(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
disk_move_request_resource |
google.cloud.compute_v1.types.DiskMoveRequest
The body resource for this request This corresponds to the |
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. |
move_instance
move_instance(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.MoveInstanceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
instance_move_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.InstanceMoveRequest
] = 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
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>
.
[Deprecated] This method is deprecated. See moving instance
across
zones </compute/docs/instances/moving-instance-across-zones>
instead.
# 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_move_instance():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.MoveInstanceProjectRequest(
project="project_value",
)
# Make the request
response = client.move_instance(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
instance_move_request_resource |
google.cloud.compute_v1.types.InstanceMoveRequest
The body resource for this request This corresponds to the |
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. |
move_instance_unary
move_instance_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.MoveInstanceProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
instance_move_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.InstanceMoveRequest
] = 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
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>
.
[Deprecated] This method is deprecated. See moving instance
across
zones </compute/docs/instances/moving-instance-across-zones>
instead.
# 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_move_instance():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.MoveInstanceProjectRequest(
project="project_value",
)
# Make the request
response = client.move_instance(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
instance_move_request_resource |
google.cloud.compute_v1.types.InstanceMoveRequest
The body resource for this request This corresponds to the |
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. |
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.
set_cloud_armor_tier
set_cloud_armor_tier(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetCloudArmorTierProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_set_cloud_armor_tier_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsSetCloudArmorTierRequest
] = 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
Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.
# 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_cloud_armor_tier():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetCloudArmorTierProjectRequest(
project="project_value",
)
# Make the request
response = client.set_cloud_armor_tier(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetCloudArmorTierProjectRequest, dict]
The request object. A request message for Projects.SetCloudArmorTier. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
projects_set_cloud_armor_tier_request_resource |
google.cloud.compute_v1.types.ProjectsSetCloudArmorTierRequest
The body resource for this request This corresponds to the |
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_cloud_armor_tier_unary
set_cloud_armor_tier_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetCloudArmorTierProjectRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
projects_set_cloud_armor_tier_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsSetCloudArmorTierRequest
] = 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
Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.
# 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_cloud_armor_tier():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetCloudArmorTierProjectRequest(
project="project_value",
)
# Make the request
response = client.set_cloud_armor_tier(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetCloudArmorTierProjectRequest, dict]
The request object. A request message for Projects.SetCloudArmorTier. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
projects_set_cloud_armor_tier_request_resource |
google.cloud.compute_v1.types.ProjectsSetCloudArmorTierRequest
The body resource for this request This corresponds to the |
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_common_instance_metadata
set_common_instance_metadata(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetCommonInstanceMetadataProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
metadata_resource: typing.Optional[
google.cloud.compute_v1.types.compute.Metadata
] = 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
Sets metadata common to all instances within the specified project using the data included in the request.
# 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_common_instance_metadata():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetCommonInstanceMetadataProjectRequest(
project="project_value",
)
# Make the request
response = client.set_common_instance_metadata(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
metadata_resource |
google.cloud.compute_v1.types.Metadata
The body resource for this request This corresponds to the |
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_common_instance_metadata_unary
set_common_instance_metadata_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetCommonInstanceMetadataProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
metadata_resource: typing.Optional[
google.cloud.compute_v1.types.compute.Metadata
] = 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
Sets metadata common to all instances within the specified project using the data included in the request.
# 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_common_instance_metadata():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetCommonInstanceMetadataProjectRequest(
project="project_value",
)
# Make the request
response = client.set_common_instance_metadata(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
metadata_resource |
google.cloud.compute_v1.types.Metadata
The body resource for this request This corresponds to the |
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_default_network_tier
set_default_network_tier(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetDefaultNetworkTierProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
projects_set_default_network_tier_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsSetDefaultNetworkTierRequest
] = 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
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.
# 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_default_network_tier():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetDefaultNetworkTierProjectRequest(
project="project_value",
)
# Make the request
response = client.set_default_network_tier(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_set_default_network_tier_request_resource |
google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest
The body resource for this request This corresponds to the |
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_default_network_tier_unary
set_default_network_tier_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetDefaultNetworkTierProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
projects_set_default_network_tier_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ProjectsSetDefaultNetworkTierRequest
] = 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
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.
# 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_default_network_tier():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetDefaultNetworkTierProjectRequest(
project="project_value",
)
# Make the request
response = client.set_default_network_tier(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
projects_set_default_network_tier_request_resource |
google.cloud.compute_v1.types.ProjectsSetDefaultNetworkTierRequest
The body resource for this request This corresponds to the |
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_usage_export_bucket
set_usage_export_bucket(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetUsageExportBucketProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
usage_export_location_resource: typing.Optional[
google.cloud.compute_v1.types.compute.UsageExportLocation
] = 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
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.
# 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_usage_export_bucket():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetUsageExportBucketProjectRequest(
project="project_value",
)
# Make the request
response = client.set_usage_export_bucket(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
usage_export_location_resource |
google.cloud.compute_v1.types.UsageExportLocation
The body resource for this request This corresponds to the |
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_usage_export_bucket_unary
set_usage_export_bucket_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetUsageExportBucketProjectRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
usage_export_location_resource: typing.Optional[
google.cloud.compute_v1.types.compute.UsageExportLocation
] = 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
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.
# 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_usage_export_bucket():
# Create a client
client = compute_v1.ProjectsClient()
# Initialize request argument(s)
request = compute_v1.SetUsageExportBucketProjectRequest(
project="project_value",
)
# Make the request
response = client.set_usage_export_bucket(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
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 |
usage_export_location_resource |
google.cloud.compute_v1.types.UsageExportLocation
The body resource for this request This corresponds to the |
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. |