Google Cloud VMware Engine V1 API - Class Google::Cloud::VmwareEngine::V1::VmwareEngine::Client (v0.1.1)

Version 0.1.1

• 0.10.0 (latest)
• 0.9.2
• 0.8.0
• 0.7.1
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.1

Reference documentation and code samples for the Google Cloud VMware Engine V1 API class Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.

Client for the VmwareEngine service.

VMwareEngine manages VMware's private clusters in the Cloud.

Inherits

• Object

Includes

• Google::Cloud::VmwareEngine::V1::VmwareEngine::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the VmwareEngine Client class.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

Example

# Modify the configuration for all VmwareEngine clients
::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the VmwareEngine Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

• (config) — Configure the Client client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client::Configuration)

#create_cluster

def create_cluster(request, options = nil) -> ::Gapic::Operation
def create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

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.

Overloads

def create_cluster(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_cluster via a request object, either of type CreateClusterRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::CreateClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• cluster_id (::String) —

  Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
• cluster (::Google::Cloud::VmwareEngine::V1::Cluster, ::Hash) — Required. The initial description of the new cluster.
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
• validate_only (::Boolean) — Optional. True if you want the request to be validated and not executed; false otherwise.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::CreateClusterRequest.new

# Call the create_cluster method.
result = client.create_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_hcx_activation_key

def create_hcx_activation_key(request, options = nil) -> ::Gapic::Operation
def create_hcx_activation_key(parent: nil, hcx_activation_key: nil, hcx_activation_key_id: nil, request_id: nil) -> ::Gapic::Operation

Creates a new HCX activation key in a given private cloud.

Overloads

def create_hcx_activation_key(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_hcx_activation_key via a request object, either of type CreateHcxActivationKeyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::CreateHcxActivationKeyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_hcx_activation_key(parent: nil, hcx_activation_key: nil, hcx_activation_key_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_hcx_activation_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1/privateClouds/my-cloud
• hcx_activation_key (::Google::Cloud::VmwareEngine::V1::HcxActivationKey, ::Hash) — Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.
• hcx_activation_key_id (::String) —

  Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
• request_id (::String) — A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::CreateHcxActivationKeyRequest.new

# Call the create_hcx_activation_key method.
result = client.create_hcx_activation_key request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_network_policy

def create_network_policy(request, options = nil) -> ::Gapic::Operation
def create_network_policy(parent: nil, network_policy_id: nil, network_policy: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def create_network_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_network_policy via a request object, either of type CreateNetworkPolicyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::CreateNetworkPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_network_policy(parent: nil, network_policy_id: nil, network_policy: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_network_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1
• network_policy_id (::String) —

  Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
• network_policy (::Google::Cloud::VmwareEngine::V1::NetworkPolicy, ::Hash) — Required. The network policy configuration to use in the request.
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::CreateNetworkPolicyRequest.new

# Call the create_network_policy method.
result = client.create_network_policy request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_private_cloud

def create_private_cloud(request, options = nil) -> ::Gapic::Operation
def create_private_cloud(parent: nil, private_cloud_id: nil, private_cloud: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

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 for that private cloud.

Overloads

def create_private_cloud(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_private_cloud via a request object, either of type CreatePrivateCloudRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::CreatePrivateCloudRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_private_cloud(parent: nil, private_cloud_id: nil, private_cloud: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to create_private_cloud via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a
• private_cloud_id (::String) —

  Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each PrivateCloud within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
• private_cloud (::Google::Cloud::VmwareEngine::V1::PrivateCloud, ::Hash) — Required. The initial description of the new private cloud.
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
• validate_only (::Boolean) — Optional. True if you want the request to be validated and not executed; false otherwise.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::CreatePrivateCloudRequest.new

# Call the create_private_cloud method.
result = client.create_private_cloud request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_vmware_engine_network

def create_vmware_engine_network(request, options = nil) -> ::Gapic::Operation
def create_vmware_engine_network(parent: nil, vmware_engine_network_id: nil, vmware_engine_network: nil, request_id: nil) -> ::Gapic::Operation

Creates a new VMware Engine network that can be used by a private cloud.

Overloads

def create_vmware_engine_network(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_vmware_engine_network via a request object, either of type CreateVmwareEngineNetworkRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::CreateVmwareEngineNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_vmware_engine_network(parent: nil, vmware_engine_network_id: nil, vmware_engine_network: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_vmware_engine_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type LEGACY is a regional resource, and a VMware Engine network of type STANDARD is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global
• vmware_engine_network_id (::String) —

  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: {region-id}-default. Replace {region-id} with the region where you want to create the VMware Engine network. For example, "us-central1-default".
  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
• vmware_engine_network (::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork, ::Hash) — Required. The initial description of the new VMware Engine network.
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::CreateVmwareEngineNetworkRequest.new

# Call the create_vmware_engine_network method.
result = client.create_vmware_engine_network request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_cluster

def delete_cluster(request, options = nil) -> ::Gapic::Operation
def delete_cluster(name: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def delete_cluster(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_cluster via a request object, either of type DeleteClusterRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::DeleteClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_cluster(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::DeleteClusterRequest.new

# Call the delete_cluster method.
result = client.delete_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_network_policy

def delete_network_policy(request, options = nil) -> ::Gapic::Operation
def delete_network_policy(name: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def delete_network_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_network_policy via a request object, either of type DeleteNetworkPolicyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::DeleteNetworkPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_network_policy(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_network_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — 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: projects/my-project/locations/us-central1/networkPolicies/my-network-policy
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::DeleteNetworkPolicyRequest.new

# Call the delete_network_policy method.
result = client.delete_network_policy request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_private_cloud

def delete_private_cloud(request, options = nil) -> ::Gapic::Operation
def delete_private_cloud(name: nil, request_id: nil, force: nil, delay_hours: nil) -> ::Gapic::Operation

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.

Overloads

def delete_private_cloud(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_private_cloud via a request object, either of type DeletePrivateCloudRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::DeletePrivateCloudRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_private_cloud(name: nil, request_id: nil, force: nil, delay_hours: nil) -> ::Gapic::Operation

Pass arguments to delete_private_cloud via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
• force (::Boolean) — Optional. If set to true, cascade delete is enabled and all children of this private cloud resource are also deleted. When this flag is set to false, the private cloud will not be deleted if there are any children other than the management cluster. The management cluster is always deleted.
• delay_hours (::Integer) — Optional. Time delay of the deletion specified in hours. The default value is 3. Specifying a non-zero value for this field changes the value of PrivateCloud.state to DELETED and sets expire_time to the planned deletion time. Deletion can be cancelled before expire_time elapses using VmwareEngine.UndeletePrivateCloud. Specifying a value of 0 for this field instead begins the deletion process and ceases billing immediately. During the final deletion process, the value of PrivateCloud.state becomes PURGING.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::DeletePrivateCloudRequest.new

# Call the delete_private_cloud method.
result = client.delete_private_cloud request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_vmware_engine_network

def delete_vmware_engine_network(request, options = nil) -> ::Gapic::Operation
def delete_vmware_engine_network(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation

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.

Overloads

def delete_vmware_engine_network(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_vmware_engine_network via a request object, either of type DeleteVmwareEngineNetworkRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::DeleteVmwareEngineNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_vmware_engine_network(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation

Pass arguments to delete_vmware_engine_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — 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: projects/my-project/locations/global/vmwareEngineNetworks/my-network
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• etag (::String) — Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an ABORTED error.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::DeleteVmwareEngineNetworkRequest.new

# Call the delete_vmware_engine_network method.
result = client.delete_vmware_engine_network request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#get_cluster

def get_cluster(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Cluster
def get_cluster(name: nil) -> ::Google::Cloud::VmwareEngine::V1::Cluster

Retrieves a Cluster resource by its resource name.

Overloads

def get_cluster(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Cluster

Pass arguments to get_cluster via a request object, either of type GetClusterRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_cluster(name: nil) -> ::Google::Cloud::VmwareEngine::V1::Cluster

Pass arguments to get_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::Cluster)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::Cluster)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetClusterRequest.new

# Call the get_cluster method.
result = client.get_cluster request

# The returned object is of type Google::Cloud::VmwareEngine::V1::Cluster.
p result

#get_hcx_activation_key

def get_hcx_activation_key(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::HcxActivationKey
def get_hcx_activation_key(name: nil) -> ::Google::Cloud::VmwareEngine::V1::HcxActivationKey

Retrieves a HcxActivationKey resource by its resource name.

Overloads

def get_hcx_activation_key(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::HcxActivationKey

Pass arguments to get_hcx_activation_key via a request object, either of type GetHcxActivationKeyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetHcxActivationKeyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_hcx_activation_key(name: nil) -> ::Google::Cloud::VmwareEngine::V1::HcxActivationKey

Pass arguments to get_hcx_activation_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::HcxActivationKey)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::HcxActivationKey)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetHcxActivationKeyRequest.new

# Call the get_hcx_activation_key method.
result = client.get_hcx_activation_key request

# The returned object is of type Google::Cloud::VmwareEngine::V1::HcxActivationKey.
p result

#get_network_policy

def get_network_policy(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPolicy
def get_network_policy(name: nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPolicy

Retrieves a NetworkPolicy resource by its resource name.

Overloads

def get_network_policy(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPolicy

Pass arguments to get_network_policy via a request object, either of type GetNetworkPolicyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetNetworkPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_network_policy(name: nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPolicy

Pass arguments to get_network_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-project/locations/us-central1/networkPolicies/my-network-policy

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::NetworkPolicy)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::NetworkPolicy)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetNetworkPolicyRequest.new

# Call the get_network_policy method.
result = client.get_network_policy request

# The returned object is of type Google::Cloud::VmwareEngine::V1::NetworkPolicy.
p result

#get_node_type

def get_node_type(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::NodeType
def get_node_type(name: nil) -> ::Google::Cloud::VmwareEngine::V1::NodeType

Gets details of a single NodeType.

Overloads

def get_node_type(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::NodeType

Pass arguments to get_node_type via a request object, either of type GetNodeTypeRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetNodeTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_node_type(name: nil) -> ::Google::Cloud::VmwareEngine::V1::NodeType

Pass arguments to get_node_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-proj/locations/us-central1-a/nodeTypes/standard-72

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::NodeType)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::NodeType)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetNodeTypeRequest.new

# Call the get_node_type method.
result = client.get_node_type request

# The returned object is of type Google::Cloud::VmwareEngine::V1::NodeType.
p result

#get_private_cloud

def get_private_cloud(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateCloud
def get_private_cloud(name: nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateCloud

Retrieves a PrivateCloud resource by its resource name.

Overloads

def get_private_cloud(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateCloud

Pass arguments to get_private_cloud via a request object, either of type GetPrivateCloudRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetPrivateCloudRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_private_cloud(name: nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateCloud

Pass arguments to get_private_cloud via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::PrivateCloud)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::PrivateCloud)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetPrivateCloudRequest.new

# Call the get_private_cloud method.
result = client.get_private_cloud request

# The returned object is of type Google::Cloud::VmwareEngine::V1::PrivateCloud.
p result

#get_vmware_engine_network

def get_vmware_engine_network(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork
def get_vmware_engine_network(name: nil) -> ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork

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).

Overloads

def get_vmware_engine_network(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork

Pass arguments to get_vmware_engine_network via a request object, either of type GetVmwareEngineNetworkRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::GetVmwareEngineNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_vmware_engine_network(name: nil) -> ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork

Pass arguments to get_vmware_engine_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• name (::String) — 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: projects/my-project/locations/global/vmwareEngineNetworks/my-network

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::GetVmwareEngineNetworkRequest.new

# Call the get_vmware_engine_network method.
result = client.get_vmware_engine_network request

# The returned object is of type Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

• (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new VmwareEngine client object.

Yields

• (config) — Configure the VmwareEngine client.

Yield Parameter

• config (Client::Configuration)

Returns

• (Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new do |config|
  config.timeout = 10.0
end

#list_clusters

def list_clusters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>
def list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>

Lists Cluster resources in a given private cloud.

Overloads

def list_clusters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>

Pass arguments to list_clusters via a request object, either of type ListClustersRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>

Pass arguments to list_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• page_size (::Integer) — The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

• filter (::String) — To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-cluster") (nodeCount = "3")

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2")

• order_by (::String) — Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Cluster>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListClustersRequest.new

# Call the list_clusters method.
result = client.list_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::Cluster.
  p response
end

#list_hcx_activation_keys

def list_hcx_activation_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>
def list_hcx_activation_keys(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>

Lists HcxActivationKey resources in a given private cloud.

Overloads

def list_hcx_activation_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>

Pass arguments to list_hcx_activation_keys via a request object, either of type ListHcxActivationKeysRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListHcxActivationKeysRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_hcx_activation_keys(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>

Pass arguments to list_hcx_activation_keys via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1/privateClouds/my-cloud
• page_size (::Integer) — The maximum number of HCX activation keys to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListHcxActivationKeys call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListHcxActivationKeys must match the call that provided the page token.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListHcxActivationKeysRequest.new

# Call the list_hcx_activation_keys method.
result = client.list_hcx_activation_keys request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::HcxActivationKey.
  p response
end

#list_network_policies

def list_network_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>
def list_network_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>

Lists NetworkPolicy resources in a specified project and location.

Overloads

def list_network_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>

Pass arguments to list_network_policies via a request object, either of type ListNetworkPoliciesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListNetworkPoliciesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_network_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>

Pass arguments to list_network_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1
• page_size (::Integer) — The maximum number of network policies to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListNetworkPolicies call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListNetworkPolicies must match the call that provided the page token.

• filter (::String) — A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

  For example, if you are filtering a list of network policies, you can exclude the ones named example-policy by specifying name != "example-policy".

  To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-policy") (createTime > "2021-04-12T08:15:10.40Z")

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-policy-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-policy-2")

• order_by (::String) — Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListNetworkPoliciesRequest.new

# Call the list_network_policies method.
result = client.list_network_policies request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::NetworkPolicy.
  p response
end

#list_node_types

def list_node_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>
def list_node_types(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>

Lists node types

Overloads

def list_node_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>

Pass arguments to list_node_types via a request object, either of type ListNodeTypesRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListNodeTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_node_types(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>

Pass arguments to list_node_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a
• page_size (::Integer) — The maximum number of node types to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListNodeTypes call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListNodeTypes must match the call that provided the page token.

• filter (::String) — A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

  For example, if you are filtering a list of node types, you can exclude the ones named standard-72 by specifying name != "standard-72".

  To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "standard-72") (virtual_cpu_count > 2)

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "standard-96") AND (virtual_cpu_count > 2) OR (name = "standard-72")

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NodeType>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListNodeTypesRequest.new

# Call the list_node_types method.
result = client.list_node_types request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::NodeType.
  p response
end

#list_private_clouds

def list_private_clouds(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>
def list_private_clouds(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>

Lists PrivateCloud resources in a given project and location.

Overloads

def list_private_clouds(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>

Pass arguments to list_private_clouds via a request object, either of type ListPrivateCloudsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListPrivateCloudsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_private_clouds(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>

Pass arguments to list_private_clouds via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a
• page_size (::Integer) — The maximum number of private clouds to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListPrivateClouds call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListPrivateClouds must match the call that provided the page token.

• filter (::String) — A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

  For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

  You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

  To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "private-cloud-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-2")

• order_by (::String) — Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateCloud>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListPrivateCloudsRequest.new

# Call the list_private_clouds method.
result = client.list_private_clouds request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::PrivateCloud.
  p response
end

#list_subnets

def list_subnets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>
def list_subnets(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>

Lists subnets in a given private cloud.

Overloads

def list_subnets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>

Pass arguments to list_subnets via a request object, either of type ListSubnetsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListSubnetsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_subnets(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>

Pass arguments to list_subnets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• page_size (::Integer) — The maximum number of subnets to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListSubnetsRequest call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListSubnetsRequest must match the call that provided the page token.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Subnet>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListSubnetsRequest.new

# Call the list_subnets method.
result = client.list_subnets request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::Subnet.
  p response
end

#list_vmware_engine_networks

def list_vmware_engine_networks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>
def list_vmware_engine_networks(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>

Lists VmwareEngineNetwork resources in a given project and location.

Overloads

def list_vmware_engine_networks(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>

Pass arguments to list_vmware_engine_networks via a request object, either of type ListVmwareEngineNetworksRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ListVmwareEngineNetworksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_vmware_engine_networks(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>

Pass arguments to list_vmware_engine_networks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• parent (::String) — 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: projects/my-project/locations/global
• page_size (::Integer) — The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
• page_token (::String) — A page token, received from a previous ListVmwareEngineNetworks call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListVmwareEngineNetworks must match the call that provided the page token.

• filter (::String) — A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

  For example, if you are filtering a list of network peerings, you can exclude the ones named example-network by specifying name != "example-network".

  To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-network") (createTime > "2021-04-12T08:15:10.40Z")

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-network-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-network-2")

• order_by (::String) — Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ListVmwareEngineNetworksRequest.new

# Call the list_vmware_engine_networks method.
result = client.list_vmware_engine_networks request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork.
  p response
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

• (Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::VmwareEngine::V1::VmwareEngine::Operations

Get the associated client for long-running operations.

Returns

• (::Google::Cloud::VmwareEngine::V1::VmwareEngine::Operations)

#reset_nsx_credentials

def reset_nsx_credentials(request, options = nil) -> ::Gapic::Operation
def reset_nsx_credentials(private_cloud: nil, request_id: nil) -> ::Gapic::Operation

Resets credentials of the NSX appliance.

Overloads

def reset_nsx_credentials(request, options = nil) -> ::Gapic::Operation

Pass arguments to reset_nsx_credentials via a request object, either of type ResetNsxCredentialsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ResetNsxCredentialsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def reset_nsx_credentials(private_cloud: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to reset_nsx_credentials via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• private_cloud (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ResetNsxCredentialsRequest.new

# Call the reset_nsx_credentials method.
result = client.reset_nsx_credentials request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#reset_vcenter_credentials

def reset_vcenter_credentials(request, options = nil) -> ::Gapic::Operation
def reset_vcenter_credentials(private_cloud: nil, request_id: nil) -> ::Gapic::Operation

Resets credentials of the Vcenter appliance.

Overloads

def reset_vcenter_credentials(request, options = nil) -> ::Gapic::Operation

Pass arguments to reset_vcenter_credentials via a request object, either of type ResetVcenterCredentialsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ResetVcenterCredentialsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def reset_vcenter_credentials(private_cloud: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to reset_vcenter_credentials via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• private_cloud (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ResetVcenterCredentialsRequest.new

# Call the reset_vcenter_credentials method.
result = client.reset_vcenter_credentials request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#show_nsx_credentials

def show_nsx_credentials(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials
def show_nsx_credentials(private_cloud: nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Gets details of credentials for NSX appliance.

Overloads

def show_nsx_credentials(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Pass arguments to show_nsx_credentials via a request object, either of type ShowNsxCredentialsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ShowNsxCredentialsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def show_nsx_credentials(private_cloud: nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Pass arguments to show_nsx_credentials via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• private_cloud (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::Credentials)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::Credentials)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ShowNsxCredentialsRequest.new

# Call the show_nsx_credentials method.
result = client.show_nsx_credentials request

# The returned object is of type Google::Cloud::VmwareEngine::V1::Credentials.
p result

#show_vcenter_credentials

def show_vcenter_credentials(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials
def show_vcenter_credentials(private_cloud: nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Gets details of credentials for Vcenter appliance.

Overloads

def show_vcenter_credentials(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Pass arguments to show_vcenter_credentials via a request object, either of type ShowVcenterCredentialsRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::ShowVcenterCredentialsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def show_vcenter_credentials(private_cloud: nil) -> ::Google::Cloud::VmwareEngine::V1::Credentials

Pass arguments to show_vcenter_credentials via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

• private_cloud (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Google::Cloud::VmwareEngine::V1::Credentials)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Google::Cloud::VmwareEngine::V1::Credentials)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::ShowVcenterCredentialsRequest.new

# Call the show_vcenter_credentials method.
result = client.show_vcenter_credentials request

# The returned object is of type Google::Cloud::VmwareEngine::V1::Credentials.
p result

#undelete_private_cloud

def undelete_private_cloud(request, options = nil) -> ::Gapic::Operation
def undelete_private_cloud(name: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def undelete_private_cloud(request, options = nil) -> ::Gapic::Operation

Pass arguments to undelete_private_cloud via a request object, either of type UndeletePrivateCloudRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::UndeletePrivateCloudRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def undelete_private_cloud(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to undelete_private_cloud via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• name (::String) — 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: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::UndeletePrivateCloudRequest.new

# Call the undelete_private_cloud method.
result = client.undelete_private_cloud request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#update_cluster

def update_cluster(request, options = nil) -> ::Gapic::Operation
def update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

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.

Overloads

def update_cluster(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_cluster via a request object, either of type UpdateClusterRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::UpdateClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_cluster(update_mask: nil, cluster: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Pass arguments to update_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
• cluster (::Google::Cloud::VmwareEngine::V1::Cluster, ::Hash) — Required. The description of the cluster.
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
• validate_only (::Boolean) — Optional. True if you want the request to be validated and not executed; false otherwise.

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::UpdateClusterRequest.new

# Call the update_cluster method.
result = client.update_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#update_network_policy

def update_network_policy(request, options = nil) -> ::Gapic::Operation
def update_network_policy(network_policy: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def update_network_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_network_policy via a request object, either of type UpdateNetworkPolicyRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::UpdateNetworkPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_network_policy(network_policy: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_network_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• network_policy (::Google::Cloud::VmwareEngine::V1::NetworkPolicy, ::Hash) — Required. Network policy description.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the NetworkPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::UpdateNetworkPolicyRequest.new

# Call the update_network_policy method.
result = client.update_network_policy request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#update_private_cloud

def update_private_cloud(request, options = nil) -> ::Gapic::Operation
def update_private_cloud(private_cloud: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

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.

Overloads

def update_private_cloud(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_private_cloud via a request object, either of type UpdatePrivateCloudRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::UpdatePrivateCloudRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_private_cloud(private_cloud: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_private_cloud via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• private_cloud (::Google::Cloud::VmwareEngine::V1::PrivateCloud, ::Hash) — Required. Private cloud description.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the PrivateCloud resource by the update. The fields specified in updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
• request_id (::String) — Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::UpdatePrivateCloudRequest.new

# Call the update_private_cloud method.
result = client.update_private_cloud request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#update_vmware_engine_network

def update_vmware_engine_network(request, options = nil) -> ::Gapic::Operation
def update_vmware_engine_network(vmware_engine_network: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Overloads

def update_vmware_engine_network(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_vmware_engine_network via a request object, either of type UpdateVmwareEngineNetworkRequest or an equivalent Hash.

Parameters

• request (::Google::Cloud::VmwareEngine::V1::UpdateVmwareEngineNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
• options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_vmware_engine_network(vmware_engine_network: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_vmware_engine_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

• vmware_engine_network (::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork, ::Hash) — Required. VMware Engine network description.
• update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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 update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Only the following fields can be updated: description.
• request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

• (response, operation) — Access the result along with the RPC operation

Yield Parameters

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns

• (::Gapic::Operation)

Raises

• (::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/vmware_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VmwareEngine::V1::VmwareEngine::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VmwareEngine::V1::UpdateVmwareEngineNetworkRequest.new

# Call the update_vmware_engine_network method.
result = client.update_vmware_engine_network request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end