Google Cloud VMware Engine V1 API - Class Google::Cloud::VmwareEngine::V1::VmwareEngine::Client (v0.7.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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_external_access_rule

def create_external_access_rule(request, options = nil) -> ::Gapic::Operation
def create_external_access_rule(parent: nil, external_access_rule: nil, external_access_rule_id: nil, request_id: nil) -> ::Gapic::Operation

Creates a new external access rule in a given network policy.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreateExternalAccessRuleRequest, ::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_external_access_rule(parent: nil, external_access_rule: nil, external_access_rule_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_external_access_rule 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 network policy to create a new external access firewall rule 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/networkPolicies/my-policy
external_access_rule (::Google::Cloud::VmwareEngine::V1::ExternalAccessRule, ::Hash) — Required. The initial description of a new external access rule.
external_access_rule_id (::String) —
Required. The user-provided identifier of the ExternalAccessRule to be created. This identifier must be unique among ExternalAccessRule 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 the 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::CreateExternalAccessRuleRequest.new

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

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

#create_external_address

def create_external_address(request, options = nil) -> ::Gapic::Operation
def create_external_address(parent: nil, external_address: nil, external_address_id: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreateExternalAddressRequest, ::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_external_address(parent: nil, external_address: nil, external_address_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_external_address 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 external IP address 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
external_address (::Google::Cloud::VmwareEngine::V1::ExternalAddress, ::Hash) — Required. The initial description of a new external IP address.
external_address_id (::String) —
Required. The user-provided identifier of the ExternalAddress to be created. This identifier must be unique among ExternalAddress 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) — 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 the 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::CreateExternalAddressRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_logging_server

def create_logging_server(request, options = nil) -> ::Gapic::Operation
def create_logging_server(parent: nil, logging_server: nil, logging_server_id: nil, request_id: nil) -> ::Gapic::Operation

Create a new logging server for a given private cloud.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreateLoggingServerRequest, ::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_logging_server(parent: nil, logging_server: nil, logging_server_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_logging_server 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 Logging Server 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
logging_server (::Google::Cloud::VmwareEngine::V1::LoggingServer, ::Hash) — Required. The initial description of a new logging server.
logging_server_id (::String) —
Required. The user-provided identifier of the LoggingServer to be created. This identifier must be unique among LoggingServer 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) — 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::CreateLoggingServerRequest.new

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

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

#create_management_dns_zone_binding

def create_management_dns_zone_binding(request, options = nil) -> ::Gapic::Operation
def create_management_dns_zone_binding(parent: nil, management_dns_zone_binding: nil, management_dns_zone_binding_id: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ManagementDnsZoneBinding resource in a private cloud. This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreateManagementDnsZoneBindingRequest, ::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_management_dns_zone_binding(parent: nil, management_dns_zone_binding: nil, management_dns_zone_binding_id: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_management_dns_zone_binding 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 management DNS zone binding 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
management_dns_zone_binding (::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding, ::Hash) — Required. The initial values for a new management DNS zone binding.
management_dns_zone_binding_id (::String) —
Required. The user-provided identifier of the ManagementDnsZoneBinding resource to be created. This identifier must be unique among ManagementDnsZoneBinding 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) — 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 the 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::CreateManagementDnsZoneBindingRequest.new

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

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

#create_network_peering

def create_network_peering(request, options = nil) -> ::Gapic::Operation
def create_network_peering(parent: nil, network_peering_id: nil, network_peering: nil, request_id: nil) -> ::Gapic::Operation

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreateNetworkPeeringRequest, ::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_peering(parent: nil, network_peering_id: nil, network_peering: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_network_peering 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 network peering in. This value is always global, because NetworkPeering 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
network_peering_id (::String) —
Required. The user-provided identifier of the new NetworkPeering. This identifier must be unique among NetworkPeering 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)
network_peering (::Google::Cloud::VmwareEngine::V1::NetworkPeering, ::Hash) — Required. The initial description of the new network peering.
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::CreateNetworkPeeringRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. 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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_private_connection

def create_private_connection(request, options = nil) -> ::Gapic::Operation
def create_private_connection(parent: nil, private_connection_id: nil, private_connection: nil, request_id: nil) -> ::Gapic::Operation

Creates a new private connection that can be used for accessing private Clouds.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::CreatePrivateConnectionRequest, ::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_connection(parent: nil, private_connection_id: nil, private_connection: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_private_connection 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 connection in. Private connection is a regional 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/us-central1
private_connection_id (::String) —
Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection 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)
private_connection (::Google::Cloud::VmwareEngine::V1::PrivateConnection, ::Hash) — Required. The initial description of the new private connection.
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::CreatePrivateConnectionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_external_access_rule

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

Deletes a single external access rule.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeleteExternalAccessRuleRequest, ::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_external_access_rule(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_external_access_rule 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 external access firewall rule 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-policy/externalAccessRules/my-rule
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 the 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::DeleteExternalAccessRuleRequest.new

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

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

#delete_external_address

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

Deletes a single external IP address. When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeleteExternalAddressRequest, ::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_external_address(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_external_address 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 external IP address 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/externalAddresses/my-ip
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 the 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::DeleteExternalAddressRequest.new

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

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

#delete_logging_server

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

Deletes a single logging server.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeleteLoggingServerRequest, ::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_logging_server(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_logging_server 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 logging server 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/loggingServers/my-logging-server
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::DeleteLoggingServerRequest.new

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

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

#delete_management_dns_zone_binding

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

Deletes a ManagementDnsZoneBinding resource. When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeleteManagementDnsZoneBindingRequest, ::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_management_dns_zone_binding(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_management_dns_zone_binding 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 management DNS zone binding 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/managementDnsZoneBindings/my-management-dns-zone-binding
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 the 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::DeleteManagementDnsZoneBindingRequest.new

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

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

#delete_network_peering

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

Deletes a NetworkPeering resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeleteNetworkPeeringRequest, ::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_peering(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_network_peering 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 peering 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/networkPeerings/my-peering
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::DeleteNetworkPeeringRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_private_connection

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

Deletes a PrivateConnection resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::DeletePrivateConnectionRequest, ::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_connection(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_private_connection 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 connection 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/us-central1/privateConnections/my-connection
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::DeletePrivateConnectionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#fetch_network_policy_external_addresses

def fetch_network_policy_external_addresses(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>
def fetch_network_policy_external_addresses(network_policy: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>

Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::FetchNetworkPolicyExternalAddressesRequest, ::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 fetch_network_policy_external_addresses(network_policy: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>

Pass arguments to fetch_network_policy_external_addresses 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 (::String) — Required. The resource name of the network policy to query for assigned external IP addresses. 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-policy
page_size (::Integer) — The maximum number of external IP addresses 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 FetchNetworkPolicyExternalAddresses call. Provide this to retrieve the subsequent page.

When paginating, all parameters provided to FetchNetworkPolicyExternalAddresses, except for page_size and page_token, 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::ExternalAddress>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>)

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::FetchNetworkPolicyExternalAddressesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::ExternalAddress.
  p item
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_dns_bind_permission

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

Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API. DnsBindPermission is a global resource and location can only be global.

Overloads

def get_dns_bind_permission(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::DnsBindPermission

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetDnsBindPermissionRequest, ::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_dns_bind_permission(name: nil) -> ::Google::Cloud::VmwareEngine::V1::DnsBindPermission

Pass arguments to get_dns_bind_permission 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 name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission 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/dnsBindPermission

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::DnsBindPermission)

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::GetDnsBindPermissionRequest.new

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

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

#get_dns_forwarding

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

Gets details of the DnsForwarding config.

Overloads

def get_dns_forwarding(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::DnsForwarding

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetDnsForwardingRequest, ::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_dns_forwarding(name: nil) -> ::Google::Cloud::VmwareEngine::V1::DnsForwarding

Pass arguments to get_dns_forwarding 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 a DnsForwarding 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/dnsForwarding

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::DnsForwarding)

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::GetDnsForwardingRequest.new

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

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

#get_external_access_rule

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

Gets details of a single external access rule.

Overloads

def get_external_access_rule(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::ExternalAccessRule

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetExternalAccessRuleRequest, ::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_external_access_rule(name: nil) -> ::Google::Cloud::VmwareEngine::V1::ExternalAccessRule

Pass arguments to get_external_access_rule 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 external access firewall rule 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-policy/externalAccessRules/my-rule

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::ExternalAccessRule)

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::GetExternalAccessRuleRequest.new

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

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

#get_external_address

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

Gets details of a single external IP address.

Overloads

def get_external_address(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::ExternalAddress

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetExternalAddressRequest, ::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_external_address(name: nil) -> ::Google::Cloud::VmwareEngine::V1::ExternalAddress

Pass arguments to get_external_address 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 external IP address 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/externalAddresses/my-ip

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::ExternalAddress)

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::GetExternalAddressRequest.new

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

# The returned object is of type Google::Cloud::VmwareEngine::V1::ExternalAddress.
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_logging_server

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

Gets details of a logging server.

Overloads

def get_logging_server(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::LoggingServer

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetLoggingServerRequest, ::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_logging_server(name: nil) -> ::Google::Cloud::VmwareEngine::V1::LoggingServer

Pass arguments to get_logging_server 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 Logging Server 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/loggingServers/my-logging-server

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::LoggingServer)

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::GetLoggingServerRequest.new

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

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

#get_management_dns_zone_binding

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

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Overloads

def get_management_dns_zone_binding(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetManagementDnsZoneBindingRequest, ::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_management_dns_zone_binding(name: nil) -> ::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding

Pass arguments to get_management_dns_zone_binding 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 management DNS zone binding 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/managementDnsZoneBindings/my-management-dns-zone-binding

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding)

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::GetManagementDnsZoneBindingRequest.new

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

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

#get_network_peering

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

Retrieves a NetworkPeering resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.

Overloads

def get_network_peering(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPeering

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetNetworkPeeringRequest, ::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_peering(name: nil) -> ::Google::Cloud::VmwareEngine::V1::NetworkPeering

Pass arguments to get_network_peering 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 peering 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/networkPeerings/my-peering

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::NetworkPeering)

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::GetNetworkPeeringRequest.new

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

# The returned object is of type Google::Cloud::VmwareEngine::V1::NetworkPeering.
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

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

Gets details of a single node.

Overloads

def get_node(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Node

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetNodeRequest, ::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(name: nil) -> ::Google::Cloud::VmwareEngine::V1::Node

Pass arguments to get_node 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 to retrieve. For example: projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::Node)

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::GetNodeRequest.new

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

# The returned object is of type Google::Cloud::VmwareEngine::V1::Node.
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_private_connection

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

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Overloads

def get_private_connection(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateConnection

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetPrivateConnectionRequest, ::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_connection(name: nil) -> ::Google::Cloud::VmwareEngine::V1::PrivateConnection

Pass arguments to get_private_connection 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 connection 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/privateConnections/my-connection

Yields

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

Yield Parameters

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

Returns

(::Google::Cloud::VmwareEngine::V1::PrivateConnection)

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::GetPrivateConnectionRequest.new

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

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

#get_subnet

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

Gets details of a single subnet.

Overloads

def get_subnet(request, options = nil) -> ::Google::Cloud::VmwareEngine::V1::Subnet

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GetSubnetRequest, ::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_subnet(name: nil) -> ::Google::Cloud::VmwareEngine::V1::Subnet

Pass arguments to get_subnet 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 subnet 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/subnets/my-subnet

Yields

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

Yield Parameters

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

Returns

(::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::GetSubnetRequest.new

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

# The returned object is of type Google::Cloud::VmwareEngine::V1::Subnet.
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

#grant_dns_bind_permission

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

Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project. DnsBindPermission is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::GrantDnsBindPermissionRequest, ::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 grant_dns_bind_permission(name: nil, principal: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to grant_dns_bind_permission 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 name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission 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/dnsBindPermission
principal (::Google::Cloud::VmwareEngine::V1::Principal, ::Hash) — Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.
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::GrantDnsBindPermissionRequest.new

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

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

#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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::Cluster.
  p item
end

#list_external_access_rules

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

Lists ExternalAccessRule resources in the specified network policy.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListExternalAccessRulesRequest, ::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_external_access_rules(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAccessRule>

Pass arguments to list_external_access_rules 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 network policy to query for external access firewall rules. 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-policy
page_size (::Integer) — The maximum number of external access rules 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 ListExternalAccessRulesRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExternalAccessRulesRequest 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 external access rules, you can exclude the ones named example-rule by specifying name != "example-rule".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-rule") (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-rule-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-rule-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::ExternalAccessRule>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAccessRule>)

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::ListExternalAccessRulesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::ExternalAccessRule.
  p item
end

#list_external_addresses

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

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListExternalAddressesRequest, ::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_external_addresses(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>

Pass arguments to list_external_addresses 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 external IP addresses. 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 external IP addresses 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 ListExternalAddresses call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExternalAddresses 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 IP addresses, you can exclude the ones named example-ip by specifying name != "example-ip".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-ip") (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-ip-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-ip-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::ExternalAddress>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ExternalAddress>)

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::ListExternalAddressesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::ExternalAddress.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::HcxActivationKey.
  p item
end

#list_logging_servers

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

Lists logging servers configured for a given private cloud.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListLoggingServersRequest, ::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_logging_servers(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::LoggingServer>

Pass arguments to list_logging_servers 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 logging servers. 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 logging servers 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 ListLoggingServersRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListLoggingServersRequest 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 logging servers, you can exclude the ones named example-server by specifying name != "example-server".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-server") (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-server-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-server-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::LoggingServer>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::LoggingServer>)

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::ListLoggingServersRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::LoggingServer.
  p item
end

#list_management_dns_zone_bindings

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

Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListManagementDnsZoneBindingsRequest, ::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_management_dns_zone_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding>

Pass arguments to list_management_dns_zone_bindings 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 management DNS zone bindings. 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 management DNS zone bindings 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 ListManagementDnsZoneBindings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListManagementDnsZoneBindings 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 Management DNS Zone Bindings, you can exclude the ones named example-management-dns-zone-binding by specifying name != "example-management-dns-zone-binding".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-management-dns-zone-binding") (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-management-dns-zone-binding-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-management-dns-zone-binding-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::ManagementDnsZoneBinding>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding>)

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::ListManagementDnsZoneBindingsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding.
  p item
end

#list_network_peerings

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

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListNetworkPeeringsRequest, ::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_peerings(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPeering>

Pass arguments to list_network_peerings 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 (global) to query for network peerings. 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 network peerings 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 ListNetworkPeerings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListNetworkPeerings 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-peering by specifying name != "example-peering".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-peering") (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-peering-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-peering-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::NetworkPeering>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::NetworkPeering>)

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::ListNetworkPeeringsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::NetworkPeering.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::NetworkPolicy.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::NodeType.
  p item
end

#list_nodes

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

Lists nodes in a given cluster.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListNodesRequest, ::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_nodes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Node>

Pass arguments to list_nodes 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 cluster to be queried for nodes. 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
page_size (::Integer) — The maximum number of nodes 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 ListNodes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListNodes 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::Node>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::Node>)

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::ListNodesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::Node.
  p item
end

#list_peering_routes

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

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListPeeringRoutesRequest, ::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_peering_routes(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PeeringRoute>

Pass arguments to list_peering_routes 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 network peering to retrieve peering routes from. 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/networkPeerings/my-peering
page_size (::Integer) — The maximum number of peering routes 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 ListPeeringRoutes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPeeringRoutes must match the call that provided the page token.
filter (::String) — A filter expression that matches resources returned in the response. Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

Yields

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

Yield Parameters

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

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PeeringRoute>)

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::ListPeeringRoutesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::PeeringRoute.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::PrivateCloud.
  p item
end

#list_private_connection_peering_routes

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

Lists the private connection routes exchanged over a peering connection.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListPrivateConnectionPeeringRoutesRequest, ::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_connection_peering_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PeeringRoute>

Pass arguments to list_private_connection_peering_routes 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 connection to retrieve peering routes from. 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-west1/privateConnections/my-connection
page_size (::Integer) — The maximum number of peering routes 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 ListPrivateConnectionPeeringRoutes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPrivateConnectionPeeringRoutes 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::PeeringRoute>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PeeringRoute>)

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::ListPrivateConnectionPeeringRoutesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::PeeringRoute.
  p item
end

#list_private_connections

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

Lists PrivateConnection resources in a given project and location.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::ListPrivateConnectionsRequest, ::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_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateConnection>

Pass arguments to list_private_connections 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 private connections. 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 private connections 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 ListPrivateConnections call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPrivateConnections 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 connections, you can exclude the ones named example-connection by specifying name != "example-connection".

To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-connection") (createTime > "2022-09-22T08:15:10.40Z")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-connection-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-connection-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::PrivateConnection>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::VmwareEngine::V1::PrivateConnection>)

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::ListPrivateConnectionsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::PrivateConnection.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::Subnet.
  p item
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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork.
  p item
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)

#repair_management_dns_zone_binding

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

Retries to create a ManagementDnsZoneBinding resource that is in failed state.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::RepairManagementDnsZoneBindingRequest, ::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 repair_management_dns_zone_binding(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to repair_management_dns_zone_binding 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 management DNS zone binding to repair. 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/managementDnsZoneBindings/my-management-dns-zone-binding
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 the 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::RepairManagementDnsZoneBindingRequest.new

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

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

#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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#reset_vcenter_credentials

def reset_vcenter_credentials(request, options = nil) -> ::Gapic::Operation
def reset_vcenter_credentials(private_cloud: nil, request_id: nil, username: 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, username: 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).
username (::String) — Optional. The username of the user to be to reset the credentials. The default value of this field is CloudOwner@gve.local. The provided value should be one of the following: solution-user-01@gve.local, solution-user-02@gve.local, solution-user-03@gve.local, solution-user-04@gve.local, solution-user-05@gve.local, zertoadmin@gve.local.

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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#revoke_dns_bind_permission

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

Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project. DnsBindPermission is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::RevokeDnsBindPermissionRequest, ::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 revoke_dns_bind_permission(name: nil, principal: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to revoke_dns_bind_permission 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 name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission 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/dnsBindPermission
principal (::Google::Cloud::VmwareEngine::V1::Principal, ::Hash) — Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.
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::RevokeDnsBindPermissionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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, username: 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, username: 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).

Parameters

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
username (::String) — Optional. The username of the user to be queried for credentials. The default value of this field is CloudOwner@gve.local. The provided value must be one of the following: CloudOwner@gve.local, solution-user-01@gve.local, solution-user-02@gve.local, solution-user-03@gve.local, solution-user-04@gve.local, solution-user-05@gve.local, zertoadmin@gve.local.

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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#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 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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_dns_forwarding

def update_dns_forwarding(request, options = nil) -> ::Gapic::Operation
def update_dns_forwarding(dns_forwarding: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateDnsForwardingRequest, ::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_dns_forwarding(dns_forwarding: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_dns_forwarding 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

dns_forwarding (::Google::Cloud::VmwareEngine::V1::DnsForwarding, ::Hash) — Required. DnsForwarding config details.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the DnsForwarding 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::UpdateDnsForwardingRequest.new

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

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

#update_external_access_rule

def update_external_access_rule(request, options = nil) -> ::Gapic::Operation
def update_external_access_rule(update_mask: nil, external_access_rule: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateExternalAccessRuleRequest, ::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_external_access_rule(update_mask: nil, external_access_rule: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_external_access_rule 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 ExternalAccessRule 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.
external_access_rule (::Google::Cloud::VmwareEngine::V1::ExternalAccessRule, ::Hash) — Required. Description of the external access rule.
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 the 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::UpdateExternalAccessRuleRequest.new

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

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

#update_external_address

def update_external_address(request, options = nil) -> ::Gapic::Operation
def update_external_address(update_mask: nil, external_address: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single external IP address. Only fields specified in update_mask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateExternalAddressRequest, ::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_external_address(update_mask: nil, external_address: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_external_address 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 ExternalAddress 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.
external_address (::Google::Cloud::VmwareEngine::V1::ExternalAddress, ::Hash) — Required. External IP address 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 the 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::UpdateExternalAddressRequest.new

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

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

#update_logging_server

def update_logging_server(request, options = nil) -> ::Gapic::Operation
def update_logging_server(update_mask: nil, logging_server: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateLoggingServerRequest, ::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_logging_server(update_mask: nil, logging_server: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_logging_server 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 LoggingServer 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.
logging_server (::Google::Cloud::VmwareEngine::V1::LoggingServer, ::Hash) — Required. Logging server 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::UpdateLoggingServerRequest.new

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

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

#update_management_dns_zone_binding

def update_management_dns_zone_binding(request, options = nil) -> ::Gapic::Operation
def update_management_dns_zone_binding(update_mask: nil, management_dns_zone_binding: nil, request_id: nil) -> ::Gapic::Operation

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateManagementDnsZoneBindingRequest, ::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_management_dns_zone_binding(update_mask: nil, management_dns_zone_binding: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_management_dns_zone_binding 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 ManagementDnsZoneBinding 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.
management_dns_zone_binding (::Google::Cloud::VmwareEngine::V1::ManagementDnsZoneBinding, ::Hash) — Required. New values to update the management DNS zone binding with.
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 the 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::UpdateManagementDnsZoneBindingRequest.new

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

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

#update_network_peering

def update_network_peering(request, options = nil) -> ::Gapic::Operation
def update_network_peering(network_peering: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Modifies a NetworkPeering resource. Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateNetworkPeeringRequest, ::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_peering(network_peering: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_network_peering 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_peering (::Google::Cloud::VmwareEngine::V1::NetworkPeering, ::Hash) — Required. Network peering description.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the NetworkPeering 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::UpdateNetworkPeeringRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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.

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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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.

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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_private_connection

def update_private_connection(request, options = nil) -> ::Gapic::Operation
def update_private_connection(private_connection: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdatePrivateConnectionRequest, ::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_connection(private_connection: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_private_connection 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_connection (::Google::Cloud::VmwareEngine::V1::PrivateConnection, ::Hash) — Required. Private connection description.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the PrivateConnection 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::UpdatePrivateConnectionRequest.new

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

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

#update_subnet

def update_subnet(request, options = nil) -> ::Gapic::Operation
def update_subnet(update_mask: nil, subnet: nil) -> ::Gapic::Operation

Updates the parameters of a single subnet. Only fields specified in update_mask are applied.

Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

Overloads

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

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

Parameters

request (::Google::Cloud::VmwareEngine::V1::UpdateSubnetRequest, ::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_subnet(update_mask: nil, subnet: nil) -> ::Gapic::Operation

Pass arguments to update_subnet 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 Subnet 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.
subnet (::Google::Cloud::VmwareEngine::V1::Subnet, ::Hash) — Required. Subnet description.

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::UpdateSubnetRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end