VmwareEngineClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.vmwareengine_v1.services.vmware_engine.transports.base.VmwareEngineTransport]] = 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>)VMwareEngine manages VMware's private clusters in the Cloud.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
VmwareEngineTransport | The transport used by the client instance. |
Methods
VmwareEngineClient
VmwareEngineClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.vmwareengine_v1.services.vmware_engine.transports.base.VmwareEngineTransport]] = 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 vmware engine client.
| 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 |
Union[str, VmwareEngineTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
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 |
| 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.
cluster_path
cluster_path(project: str, location: str, private_cloud: str, cluster: str)Returns a fully-qualified cluster string.
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.
create_cluster
create_cluster(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.CreateClusterRequest, dict]] = None, *, parent: Optional[str] = None, cluster: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.Cluster] = None, cluster_id: 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]] = ())Creates a new cluster in a given private cloud. Creating a new
cluster provides additional nodes for use in the parent private
cloud and requires sufficient node
quota <https://cloud.google.com/vmware-engine/quotas>__.
# 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 vmwareengine_v1
def sample_create_cluster():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.CreateClusterRequest(
parent="parent_value",
cluster_id="cluster_id_value",
)
# Make the request
operation = client.create_cluster(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.CreateClusterRequest, dict]
The request object. Request message for VmwareEngine.CreateCluster |
parent |
str
Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
cluster |
google.cloud.vmwareengine_v1.types.Cluster
Required. The initial description of the new cluster. This corresponds to the |
cluster_id |
str
Required. The user-provided identifier of the new |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster in a private cloud. |
create_hcx_activation_key
create_hcx_activation_key(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.CreateHcxActivationKeyRequest, dict]] = None, *, parent: Optional[str] = None, hcx_activation_key: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.HcxActivationKey] = None, hcx_activation_key_id: 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]] = ())Creates a new HCX activation key in a given private cloud.
# 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 vmwareengine_v1
def sample_create_hcx_activation_key():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.CreateHcxActivationKeyRequest(
parent="parent_value",
hcx_activation_key_id="hcx_activation_key_id_value",
)
# Make the request
operation = client.create_hcx_activation_key(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.CreateHcxActivationKeyRequest, dict]
The request object. Request message for VmwareEngine.CreateHcxActivationKey |
parent |
str
Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
hcx_activation_key |
google.cloud.vmwareengine_v1.types.HcxActivationKey
Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object. This corresponds to the |
hcx_activation_key_id |
str
Required. The user-provided identifier of 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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be HcxActivationKey HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones. |
create_network_policy
create_network_policy(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.CreateNetworkPolicyRequest, dict]] = None, *, parent: Optional[str] = None, network_policy: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.NetworkPolicy] = None, network_policy_id: 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]] = ())Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.
# 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 vmwareengine_v1
def sample_create_network_policy():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
network_policy = vmwareengine_v1.NetworkPolicy()
network_policy.edge_services_cidr = "edge_services_cidr_value"
request = vmwareengine_v1.CreateNetworkPolicyRequest(
parent="parent_value",
network_policy_id="network_policy_id_value",
network_policy=network_policy,
)
# Make the request
operation = client.create_network_policy(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.CreateNetworkPolicyRequest, dict]
The request object. Request message for VmwareEngine.CreateNetworkPolicy |
parent |
str
Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
network_policy |
google.cloud.vmwareengine_v1.types.NetworkPolicy
Required. The network policy configuration to use in the request. This corresponds to the |
network_policy_id |
str
Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be NetworkPolicy Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy. |
create_private_cloud
create_private_cloud(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.CreatePrivateCloudRequest, dict]] = None, *, parent: Optional[str] = None, private_cloud: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.PrivateCloud] = None, private_cloud_id: 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]] = ())Creates a new PrivateCloud resource in a given project and
location. Private clouds can only be created in zones, regional
private clouds are not supported.
Creating a private cloud also creates a management
cluster <https://cloud.google.com/vmware-engine/docs/concepts-vmware-components>__
for that private cloud.
# 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 vmwareengine_v1
def sample_create_private_cloud():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
private_cloud = vmwareengine_v1.PrivateCloud()
private_cloud.network_config.management_cidr = "management_cidr_value"
request = vmwareengine_v1.CreatePrivateCloudRequest(
parent="parent_value",
private_cloud_id="private_cloud_id_value",
private_cloud=private_cloud,
)
# Make the request
operation = client.create_private_cloud(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.CreatePrivateCloudRequest, dict]
The request object. Request message for VmwareEngine.CreatePrivateCloud |
parent |
str
Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
private_cloud |
google.cloud.vmwareengine_v1.types.PrivateCloud
Required. The initial description of the new private cloud. This corresponds to the |
private_cloud_id |
str
Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
create_vmware_engine_network
create_vmware_engine_network(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.CreateVmwareEngineNetworkRequest, dict]] = None, *, parent: Optional[str] = None, vmware_engine_network: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.VmwareEngineNetwork] = None, vmware_engine_network_id: 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]] = ())Creates a new VMware Engine network that can be used by a private cloud.
# 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 vmwareengine_v1
def sample_create_vmware_engine_network():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
vmware_engine_network = vmwareengine_v1.VmwareEngineNetwork()
vmware_engine_network.type_ = "LEGACY"
request = vmwareengine_v1.CreateVmwareEngineNetworkRequest(
parent="parent_value",
vmware_engine_network_id="vmware_engine_network_id_value",
vmware_engine_network=vmware_engine_network,
)
# Make the request
operation = client.create_vmware_engine_network(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.CreateVmwareEngineNetworkRequest, dict]
The request object. Request message for VmwareEngine.CreateVmwareEngineNetwork |
parent |
str
Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type |
vmware_engine_network |
google.cloud.vmwareengine_v1.types.VmwareEngineNetwork
Required. The initial description of the new VMware Engine network. This corresponds to the |
vmware_engine_network_id |
str
Required. The user-provided identifier of the new VMware Engine network. This identifier must be unique among VMware Engine network resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: - For networks of type LEGACY, adheres to the format: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be VmwareEngineNetwork VMware Engine network resource that provides connectivity for VMware Engine private clouds. |
delete_cluster
delete_cluster(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.DeleteClusterRequest, dict]] = None, *, name: 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]] = ())Deletes a Cluster resource. To avoid unintended data loss,
migrate or gracefully shut down any workloads running on the
cluster before deletion. You cannot delete the management
cluster of a private cloud using this method.
# 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 vmwareengine_v1
def sample_delete_cluster():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.DeleteClusterRequest(
name="name_value",
)
# Make the request
operation = client.delete_cluster(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.DeleteClusterRequest, dict]
The request object. Request message for VmwareEngine.DeleteCluster |
name |
str
Required. The resource name of the cluster to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_network_policy
delete_network_policy(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.DeleteNetworkPolicyRequest, dict]] = None, *, name: 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]] = ())Deletes a NetworkPolicy resource. A network policy cannot be
deleted when NetworkService.state is set to RECONCILING
for either its external IP or internet access service.
# 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 vmwareengine_v1
def sample_delete_network_policy():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.DeleteNetworkPolicyRequest(
name="name_value",
)
# Make the request
operation = client.delete_network_policy(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.DeleteNetworkPolicyRequest, dict]
The request object. Request message for VmwareEngine.DeleteNetworkPolicy |
name |
str
Required. The resource name of the network policy to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_operation
delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = 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]] = ())Deletes a long-running operation.
This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
| Name | Description |
request |
The request object. Request message for |
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. |
delete_private_cloud
delete_private_cloud(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.DeletePrivateCloudRequest, dict]] = None, *, name: 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]] = ())Schedules a PrivateCloud resource for deletion.
A PrivateCloud resource scheduled for deletion has
PrivateCloud.state set to DELETED and expireTime set
to the time when deletion is final and can no longer be
reversed. The delete operation is marked as done as soon as the
PrivateCloud is successfully scheduled for deletion (this
also applies when delayHours is set to zero), and the
operation is not kept in pending state until PrivateCloud is
purged. PrivateCloud can be restored using
UndeletePrivateCloud method before the expireTime
elapses. When expireTime is reached, deletion is final and
all private cloud resources are irreversibly removed and billing
stops. During the final removal process, PrivateCloud.state
is set to PURGING. PrivateCloud can be polled using
standard GET method for the whole period of deletion and
purging. It will not be returned only when it is completely
purged.
# 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 vmwareengine_v1
def sample_delete_private_cloud():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.DeletePrivateCloudRequest(
name="name_value",
)
# Make the request
operation = client.delete_private_cloud(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.DeletePrivateCloudRequest, dict]
The request object. Request message for VmwareEngine.DeletePrivateCloud |
name |
str
Required. The resource name of the private cloud to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
delete_vmware_engine_network
delete_vmware_engine_network(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.DeleteVmwareEngineNetworkRequest, dict]] = None, *, name: 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]] = ())Deletes a VmwareEngineNetwork resource. You can only delete
a VMware Engine network after all resources that refer to it are
deleted. For example, a private cloud, a network peering, and a
network policy can all refer to the same VMware Engine network.
# 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 vmwareengine_v1
def sample_delete_vmware_engine_network():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.DeleteVmwareEngineNetworkRequest(
name="name_value",
)
# Make the request
operation = client.delete_vmware_engine_network(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.DeleteVmwareEngineNetworkRequest, dict]
The request object. Request message for VmwareEngine.DeleteVmwareEngineNetwork |
name |
str
Required. The resource name of the VMware Engine network to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
VmwareEngineClient | 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.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
VmwareEngineClient | 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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
VmwareEngineClient | The constructed client. |
get_cluster
get_cluster(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetClusterRequest, dict]] = None, *, name: 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]] = ())Retrieves a Cluster resource by its resource name.
# 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 vmwareengine_v1
def sample_get_cluster():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetClusterRequest(
name="name_value",
)
# Make the request
response = client.get_cluster(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetClusterRequest, dict]
The request object. Request message for VmwareEngine.GetCluster |
name |
str
Required. The cluster resource name to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.Cluster | A cluster in a private cloud. |
get_hcx_activation_key
get_hcx_activation_key(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetHcxActivationKeyRequest, dict]] = None, *, name: 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]] = ())Retrieves a HcxActivationKey resource by its resource name.
# 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 vmwareengine_v1
def sample_get_hcx_activation_key():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetHcxActivationKeyRequest(
name="name_value",
)
# Make the request
response = client.get_hcx_activation_key(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetHcxActivationKeyRequest, dict]
The request object. Request message for [VmwareEngine.GetHcxActivationKeys][] |
name |
str
Required. The resource name of the HCX activation key to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.HcxActivationKey | HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones. |
get_iam_policy
get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = 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 IAM access control policy for a function.
Returns an empty policy if the function exists and does not have a policy set.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __. |
get_location
get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = 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 information about a location.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Location object. |
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.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_network_policy
get_network_policy(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetNetworkPolicyRequest, dict]] = None, *, name: 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]] = ())Retrieves a NetworkPolicy resource by its resource name.
# 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 vmwareengine_v1
def sample_get_network_policy():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetNetworkPolicyRequest(
name="name_value",
)
# Make the request
response = client.get_network_policy(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetNetworkPolicyRequest, dict]
The request object. Request message for VmwareEngine.GetNetworkPolicy |
name |
str
Required. The resource name of the network policy to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.NetworkPolicy | Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy. |
get_node_type
get_node_type(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetNodeTypeRequest, dict]] = None, *, name: 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 details of a single NodeType.
# 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 vmwareengine_v1
def sample_get_node_type():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetNodeTypeRequest(
name="name_value",
)
# Make the request
response = client.get_node_type(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetNodeTypeRequest, dict]
The request object. Request message for VmwareEngine.GetNodeType |
name |
str
Required. The resource name of the node type to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.NodeType | Describes node type. |
get_operation
get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = 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 latest state of a long-running operation.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| An Operation object. |
get_private_cloud
get_private_cloud(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetPrivateCloudRequest, dict]] = None, *, name: 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]] = ())Retrieves a PrivateCloud resource by its resource name.
# 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 vmwareengine_v1
def sample_get_private_cloud():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetPrivateCloudRequest(
name="name_value",
)
# Make the request
response = client.get_private_cloud(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetPrivateCloudRequest, dict]
The request object. Request message for VmwareEngine.GetPrivateCloud |
name |
str
Required. The resource name of the private cloud to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.PrivateCloud | Represents a private cloud resource. Private clouds are zonal resources. |
get_vmware_engine_network
get_vmware_engine_network(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.GetVmwareEngineNetworkRequest, dict]] = None, *, name: 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]] = ())Retrieves a VmwareEngineNetwork resource by its resource
name. The resource contains details of the VMware Engine
network, such as its VMware Engine network type, peered networks
in a service project, and state (for example, CREATING,
ACTIVE, DELETING).
# 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 vmwareengine_v1
def sample_get_vmware_engine_network():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.GetVmwareEngineNetworkRequest(
name="name_value",
)
# Make the request
response = client.get_vmware_engine_network(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.GetVmwareEngineNetworkRequest, dict]
The request object. Request message for VmwareEngine.GetVmwareEngineNetwork |
name |
str
Required. The resource name of the VMware Engine network to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.VmwareEngineNetwork | VMware Engine network resource that provides connectivity for VMware Engine private clouds. |
hcx_activation_key_path
hcx_activation_key_path(
project: str, location: str, private_cloud: str, hcx_activation_key: str
)Returns a fully-qualified hcx_activation_key string.
list_clusters
list_clusters(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListClustersRequest, dict]] = None, *, parent: 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]] = ())Lists Cluster resources in a given private cloud.
# 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 vmwareengine_v1
def sample_list_clusters():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListClustersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_clusters(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListClustersRequest, dict]
The request object. Request message for VmwareEngine.ListClusters |
parent |
str
Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListClustersPager | Response message for VmwareEngine.ListClusters Iterating over this object will yield results and resolve additional pages automatically. |
list_hcx_activation_keys
list_hcx_activation_keys(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListHcxActivationKeysRequest, dict]] = None, *, parent: 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]] = ())Lists HcxActivationKey resources in a given private cloud.
# 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 vmwareengine_v1
def sample_list_hcx_activation_keys():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListHcxActivationKeysRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_hcx_activation_keys(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListHcxActivationKeysRequest, dict]
The request object. Request message for VmwareEngine.ListHcxActivationKeys |
parent |
str
Required. The resource name of the private cloud to be queried for HCX activation keys. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListHcxActivationKeysPager | Response message for VmwareEngine.ListHcxActivationKeys Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = 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 information about the supported locations for this service.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Response message for ListLocations method. |
list_network_policies
list_network_policies(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListNetworkPoliciesRequest, dict]] = None, *, parent: 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]] = ())Lists NetworkPolicy resources in a specified project and
location.
# 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 vmwareengine_v1
def sample_list_network_policies():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListNetworkPoliciesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_network_policies(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListNetworkPoliciesRequest, dict]
The request object. Request message for VmwareEngine.ListNetworkPolicies |
parent |
str
Required. The resource name of the location (region) to query for network policies. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListNetworkPoliciesPager | Response message for VmwareEngine.ListNetworkPolicies Iterating over this object will yield results and resolve additional pages automatically. |
list_node_types
list_node_types(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListNodeTypesRequest, dict]] = None, *, parent: 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]] = ())Lists node types
# 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 vmwareengine_v1
def sample_list_node_types():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListNodeTypesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_node_types(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListNodeTypesRequest, dict]
The request object. Request message for VmwareEngine.ListNodeTypes |
parent |
str
Required. The resource name of the location to be queried for node types. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListNodeTypesPager | Response message for VmwareEngine.ListNodeTypes Iterating over this object will yield results and resolve additional pages automatically. |
list_operations
list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = 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 operations that match the specified filter in the request.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Response message for ListOperations method. |
list_private_clouds
list_private_clouds(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListPrivateCloudsRequest, dict]] = None, *, parent: 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]] = ())Lists PrivateCloud resources in a given project and
location.
# 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 vmwareengine_v1
def sample_list_private_clouds():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListPrivateCloudsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_private_clouds(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListPrivateCloudsRequest, dict]
The request object. Request message for VmwareEngine.ListPrivateClouds |
parent |
str
Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListPrivateCloudsPager | Response message for VmwareEngine.ListPrivateClouds Iterating over this object will yield results and resolve additional pages automatically. |
list_subnets
list_subnets(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListSubnetsRequest, dict]] = None, *, parent: 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]] = ())Lists subnets in a given private cloud.
# 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 vmwareengine_v1
def sample_list_subnets():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListSubnetsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_subnets(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListSubnetsRequest, dict]
The request object. Request message for VmwareEngine.ListSubnets |
parent |
str
Required. The resource name of the private cloud to be queried for subnets. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListSubnetsPager | Response message for VmwareEngine.ListSubnets Iterating over this object will yield results and resolve additional pages automatically. |
list_vmware_engine_networks
list_vmware_engine_networks(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ListVmwareEngineNetworksRequest, dict]] = None, *, parent: 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]] = ())Lists VmwareEngineNetwork resources in a given project and
location.
# 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 vmwareengine_v1
def sample_list_vmware_engine_networks():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ListVmwareEngineNetworksRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_vmware_engine_networks(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ListVmwareEngineNetworksRequest, dict]
The request object. Request message for VmwareEngine.ListVmwareEngineNetworks |
parent |
str
Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.services.vmware_engine.pagers.ListVmwareEngineNetworksPager | Response message for VmwareEngine.ListVmwareEngineNetworks Iterating over this object will yield results and resolve additional pages automatically. |
network_path
network_path(project: str, network: str)Returns a fully-qualified network string.
network_policy_path
network_policy_path(project: str, location: str, network_policy: str)Returns a fully-qualified network_policy string.
node_type_path
node_type_path(project: str, location: str, node_type: str)Returns a fully-qualified node_type string.
parse_cluster_path
parse_cluster_path(path: str)Parses a cluster path into its component segments.
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.
parse_hcx_activation_key_path
parse_hcx_activation_key_path(path: str)Parses a hcx_activation_key path into its component segments.
parse_network_path
parse_network_path(path: str)Parses a network path into its component segments.
parse_network_policy_path
parse_network_policy_path(path: str)Parses a network_policy path into its component segments.
parse_node_type_path
parse_node_type_path(path: str)Parses a node_type path into its component segments.
parse_private_cloud_path
parse_private_cloud_path(path: str)Parses a private_cloud path into its component segments.
parse_subnet_path
parse_subnet_path(path: str)Parses a subnet path into its component segments.
parse_vmware_engine_network_path
parse_vmware_engine_network_path(path: str)Parses a vmware_engine_network path into its component segments.
private_cloud_path
private_cloud_path(project: str, location: str, private_cloud: str)Returns a fully-qualified private_cloud string.
reset_nsx_credentials
reset_nsx_credentials(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ResetNsxCredentialsRequest, dict]] = None, *, private_cloud: 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]] = ())Resets credentials of the NSX appliance.
# 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 vmwareengine_v1
def sample_reset_nsx_credentials():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ResetNsxCredentialsRequest(
private_cloud="private_cloud_value",
)
# Make the request
operation = client.reset_nsx_credentials(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ResetNsxCredentialsRequest, dict]
The request object. Request message for VmwareEngine.ResetNsxCredentials |
private_cloud |
str
Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
reset_vcenter_credentials
reset_vcenter_credentials(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ResetVcenterCredentialsRequest, dict]] = None, *, private_cloud: 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]] = ())Resets credentials of the Vcenter appliance.
# 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 vmwareengine_v1
def sample_reset_vcenter_credentials():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ResetVcenterCredentialsRequest(
private_cloud="private_cloud_value",
)
# Make the request
operation = client.reset_vcenter_credentials(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ResetVcenterCredentialsRequest, dict]
The request object. Request message for VmwareEngine.ResetVcenterCredentials |
private_cloud |
str
Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
set_iam_policy
set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = 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 IAM access control policy on the specified function.
Replaces any existing policy.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __. |
show_nsx_credentials
show_nsx_credentials(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ShowNsxCredentialsRequest, dict]] = None, *, private_cloud: 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 details of credentials for NSX appliance.
# 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 vmwareengine_v1
def sample_show_nsx_credentials():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ShowNsxCredentialsRequest(
private_cloud="private_cloud_value",
)
# Make the request
response = client.show_nsx_credentials(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ShowNsxCredentialsRequest, dict]
The request object. Request message for VmwareEngine.ShowNsxCredentials |
private_cloud |
str
Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.Credentials | Credentials for a private cloud. |
show_vcenter_credentials
show_vcenter_credentials(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.ShowVcenterCredentialsRequest, dict]] = None, *, private_cloud: 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 details of credentials for Vcenter appliance.
# 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 vmwareengine_v1
def sample_show_vcenter_credentials():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.ShowVcenterCredentialsRequest(
private_cloud="private_cloud_value",
)
# Make the request
response = client.show_vcenter_credentials(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.ShowVcenterCredentialsRequest, dict]
The request object. Request message for VmwareEngine.ShowVcenterCredentials |
private_cloud |
str
Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.cloud.vmwareengine_v1.types.Credentials | Credentials for a private cloud. |
subnet_path
subnet_path(project: str, location: str, private_cloud: str, subnet: str)Returns a fully-qualified subnet string.
test_iam_permissions
test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = 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]] = ())Tests the specified IAM permissions against the IAM access control policy for a function.
If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
| Name | Description |
request |
The request object. Request message for |
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. |
| Type | Description |
| Response message for TestIamPermissions method. |
undelete_private_cloud
undelete_private_cloud(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.UndeletePrivateCloudRequest, dict]] = None, *, name: 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]] = ())Restores a private cloud that was previously scheduled for
deletion by DeletePrivateCloud. A PrivateCloud resource
scheduled for deletion has PrivateCloud.state set to
DELETED and PrivateCloud.expireTime set to the time when
deletion can no longer be reversed.
# 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 vmwareengine_v1
def sample_undelete_private_cloud():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.UndeletePrivateCloudRequest(
name="name_value",
)
# Make the request
operation = client.undelete_private_cloud(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.UndeletePrivateCloudRequest, dict]
The request object. Request message for VmwareEngine.UndeletePrivateCloud |
name |
str
Required. The resource name of the private cloud scheduled for deletion. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
update_cluster
update_cluster(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.UpdateClusterRequest, dict]] = None, *, cluster: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.Cluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())Modifies a Cluster resource. Only the following fields can
be updated: node_type_configs.*.node_count. Only fields
specified in updateMask are applied.
During operation processing, the resource is temporarily in the
ACTIVE state before the operation fully completes. For that
period of time, you can't update the resource. Use the operation
status to determine when the processing fully completes.
# 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 vmwareengine_v1
def sample_update_cluster():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
request = vmwareengine_v1.UpdateClusterRequest(
)
# Make the request
operation = client.update_cluster(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.UpdateClusterRequest, dict]
The request object. Request message for VmwareEngine.UpdateCluster |
cluster |
google.cloud.vmwareengine_v1.types.Cluster
Required. The description of the cluster. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in 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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster in a private cloud. |
update_network_policy
update_network_policy(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.UpdateNetworkPolicyRequest, dict]] = None, *, network_policy: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.NetworkPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())Modifies a NetworkPolicy resource. Only the following fields
can be updated: internet_access, external_ip,
edge_services_cidr. Only fields specified in updateMask
are applied. When updating a network policy, the external IP
network service can only be disabled if there are no external IP
addresses present in the scope of the policy. Also, a
NetworkService cannot be updated when
NetworkService.state is set to RECONCILING.
During operation processing, the resource is temporarily in the
ACTIVE state before the operation fully completes. For that
period of time, you can't update the resource. Use the operation
status to determine when the processing fully completes.
# 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 vmwareengine_v1
def sample_update_network_policy():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
network_policy = vmwareengine_v1.NetworkPolicy()
network_policy.edge_services_cidr = "edge_services_cidr_value"
request = vmwareengine_v1.UpdateNetworkPolicyRequest(
network_policy=network_policy,
)
# Make the request
operation = client.update_network_policy(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.UpdateNetworkPolicyRequest, dict]
The request object. Request message for VmwareEngine.UpdateNetworkPolicy |
network_policy |
google.cloud.vmwareengine_v1.types.NetworkPolicy
Required. Network policy description. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in 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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be NetworkPolicy Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy. |
update_private_cloud
update_private_cloud(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.UpdatePrivateCloudRequest, dict]] = None, *, private_cloud: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.PrivateCloud] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())Modifies a PrivateCloud resource. Only the following fields
can be updated: description. Only fields specified in
updateMask are applied.
During operation processing, the resource is temporarily in the
ACTIVE state before the operation fully completes. For that
period of time, you can't update the resource. Use the operation
status to determine when the processing fully completes.
# 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 vmwareengine_v1
def sample_update_private_cloud():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
private_cloud = vmwareengine_v1.PrivateCloud()
private_cloud.network_config.management_cidr = "management_cidr_value"
request = vmwareengine_v1.UpdatePrivateCloudRequest(
private_cloud=private_cloud,
)
# Make the request
operation = client.update_private_cloud(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.UpdatePrivateCloudRequest, dict]
The request object. Request message for VmwareEngine.UpdatePrivateCloud |
private_cloud |
google.cloud.vmwareengine_v1.types.PrivateCloud
Required. Private cloud description. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in 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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be PrivateCloud Represents a private cloud resource. Private clouds are zonal resources. |
update_vmware_engine_network
update_vmware_engine_network(request: Optional[Union[google.cloud.vmwareengine_v1.types.vmwareengine.UpdateVmwareEngineNetworkRequest, dict]] = None, *, vmware_engine_network: Optional[google.cloud.vmwareengine_v1.types.vmwareengine.VmwareEngineNetwork] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())Modifies a VMware Engine network resource. Only the following
fields can be updated: description. Only fields specified in
updateMask are applied.
# 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 vmwareengine_v1
def sample_update_vmware_engine_network():
# Create a client
client = vmwareengine_v1.VmwareEngineClient()
# Initialize request argument(s)
vmware_engine_network = vmwareengine_v1.VmwareEngineNetwork()
vmware_engine_network.type_ = "LEGACY"
request = vmwareengine_v1.UpdateVmwareEngineNetworkRequest(
vmware_engine_network=vmware_engine_network,
)
# Make the request
operation = client.update_vmware_engine_network(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.vmwareengine_v1.types.UpdateVmwareEngineNetworkRequest, dict]
The request object. Request message for VmwareEngine.UpdateVmwareEngineNetwork |
vmware_engine_network |
google.cloud.vmwareengine_v1.types.VmwareEngineNetwork
Required. VMware Engine network description. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in the VMware Engine network resource by the update. The fields specified in 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. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be VmwareEngineNetwork VMware Engine network resource that provides connectivity for VMware Engine private clouds. |
vmware_engine_network_path
vmware_engine_network_path(project: str, location: str, vmware_engine_network: str)Returns a fully-qualified vmware_engine_network string.