Network Services V1 API - Class Google::Cloud::NetworkServices::V1::NetworkServices::Rest::Client (v1.0.1)

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::NetworkServices::Rest::Client.

REST client for the NetworkServices service.

Service describing handlers for resources.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the NetworkServices Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all NetworkServices clients
::Google::Cloud::NetworkServices::V1::NetworkServices::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the NetworkServices 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
Returns

#create_endpoint_policy

def create_endpoint_policy(request, options = nil) -> ::Gapic::Operation
def create_endpoint_policy(parent: nil, endpoint_policy_id: nil, endpoint_policy: nil) -> ::Gapic::Operation

Creates a new EndpointPolicy in a given project and location.

Overloads 
def create_endpoint_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_endpoint_policy via a request object, either of type CreateEndpointPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateEndpointPolicyRequest, ::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_endpoint_policy(parent: nil, endpoint_policy_id: nil, endpoint_policy: nil) -> ::Gapic::Operation
Pass arguments to create_endpoint_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 parent resource of the EndpointPolicy. Must be in the format projects/*/locations/global.
  • endpoint_policy_id (::String) — Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS".
  • endpoint_policy (::Google::Cloud::NetworkServices::V1::EndpointPolicy, ::Hash) — Required. EndpointPolicy resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_endpoint_policy method.
result = client.create_endpoint_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_gateway

def create_gateway(request, options = nil) -> ::Gapic::Operation
def create_gateway(parent: nil, gateway_id: nil, gateway: nil) -> ::Gapic::Operation

Creates a new Gateway in a given project and location.

Overloads 
def create_gateway(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_gateway via a request object, either of type CreateGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateGatewayRequest, ::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_gateway(parent: nil, gateway_id: nil, gateway: nil) -> ::Gapic::Operation
Pass arguments to create_gateway 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 parent resource of the Gateway. Must be in the format projects/*/locations/*.
  • gateway_id (::String) — Required. Short name of the Gateway resource to be created.
  • gateway (::Google::Cloud::NetworkServices::V1::Gateway, ::Hash) — Required. Gateway resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_gateway method.
result = client.create_gateway 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_grpc_route

def create_grpc_route(request, options = nil) -> ::Gapic::Operation
def create_grpc_route(parent: nil, grpc_route_id: nil, grpc_route: nil) -> ::Gapic::Operation

Creates a new GrpcRoute in a given project and location.

Overloads 
def create_grpc_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_grpc_route via a request object, either of type CreateGrpcRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateGrpcRouteRequest, ::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_grpc_route(parent: nil, grpc_route_id: nil, grpc_route: nil) -> ::Gapic::Operation
Pass arguments to create_grpc_route 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 parent resource of the GrpcRoute. Must be in the format projects/*/locations/global.
  • grpc_route_id (::String) — Required. Short name of the GrpcRoute resource to be created.
  • grpc_route (::Google::Cloud::NetworkServices::V1::GrpcRoute, ::Hash) — Required. GrpcRoute resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_grpc_route method.
result = client.create_grpc_route 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_http_route

def create_http_route(request, options = nil) -> ::Gapic::Operation
def create_http_route(parent: nil, http_route_id: nil, http_route: nil) -> ::Gapic::Operation

Creates a new HttpRoute in a given project and location.

Overloads 
def create_http_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_http_route via a request object, either of type CreateHttpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateHttpRouteRequest, ::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_http_route(parent: nil, http_route_id: nil, http_route: nil) -> ::Gapic::Operation
Pass arguments to create_http_route 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 parent resource of the HttpRoute. Must be in the format projects/*/locations/global.
  • http_route_id (::String) — Required. Short name of the HttpRoute resource to be created.
  • http_route (::Google::Cloud::NetworkServices::V1::HttpRoute, ::Hash) — Required. HttpRoute resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_http_route method.
result = client.create_http_route 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_mesh

def create_mesh(request, options = nil) -> ::Gapic::Operation
def create_mesh(parent: nil, mesh_id: nil, mesh: nil) -> ::Gapic::Operation

Creates a new Mesh in a given project and location.

Overloads 
def create_mesh(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_mesh via a request object, either of type CreateMeshRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateMeshRequest, ::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_mesh(parent: nil, mesh_id: nil, mesh: nil) -> ::Gapic::Operation
Pass arguments to create_mesh 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 parent resource of the Mesh. Must be in the format projects/*/locations/global.
  • mesh_id (::String) — Required. Short name of the Mesh resource to be created.
  • mesh (::Google::Cloud::NetworkServices::V1::Mesh, ::Hash) — Required. Mesh resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_mesh method.
result = client.create_mesh 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_service_binding

def create_service_binding(request, options = nil) -> ::Gapic::Operation
def create_service_binding(parent: nil, service_binding_id: nil, service_binding: nil) -> ::Gapic::Operation

Creates a new ServiceBinding in a given project and location.

Overloads 
def create_service_binding(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_service_binding via a request object, either of type CreateServiceBindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateServiceBindingRequest, ::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_service_binding(parent: nil, service_binding_id: nil, service_binding: nil) -> ::Gapic::Operation
Pass arguments to create_service_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 parent resource of the ServiceBinding. Must be in the format projects/*/locations/global.
  • service_binding_id (::String) — Required. Short name of the ServiceBinding resource to be created.
  • service_binding (::Google::Cloud::NetworkServices::V1::ServiceBinding, ::Hash) — Required. ServiceBinding resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_service_binding method.
result = client.create_service_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_tcp_route

def create_tcp_route(request, options = nil) -> ::Gapic::Operation
def create_tcp_route(parent: nil, tcp_route_id: nil, tcp_route: nil) -> ::Gapic::Operation

Creates a new TcpRoute in a given project and location.

Overloads 
def create_tcp_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_tcp_route via a request object, either of type CreateTcpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateTcpRouteRequest, ::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_tcp_route(parent: nil, tcp_route_id: nil, tcp_route: nil) -> ::Gapic::Operation
Pass arguments to create_tcp_route 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 parent resource of the TcpRoute. Must be in the format projects/*/locations/global.
  • tcp_route_id (::String) — Required. Short name of the TcpRoute resource to be created.
  • tcp_route (::Google::Cloud::NetworkServices::V1::TcpRoute, ::Hash) — Required. TcpRoute resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_tcp_route method.
result = client.create_tcp_route 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_tls_route

def create_tls_route(request, options = nil) -> ::Gapic::Operation
def create_tls_route(parent: nil, tls_route_id: nil, tls_route: nil) -> ::Gapic::Operation

Creates a new TlsRoute in a given project and location.

Overloads 
def create_tls_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_tls_route via a request object, either of type CreateTlsRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::CreateTlsRouteRequest, ::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_tls_route(parent: nil, tls_route_id: nil, tls_route: nil) -> ::Gapic::Operation
Pass arguments to create_tls_route 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 parent resource of the TlsRoute. Must be in the format projects/*/locations/global.
  • tls_route_id (::String) — Required. Short name of the TlsRoute resource to be created.
  • tls_route (::Google::Cloud::NetworkServices::V1::TlsRoute, ::Hash) — Required. TlsRoute resource to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the create_tls_route method.
result = client.create_tls_route 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_endpoint_policy

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

Deletes a single EndpointPolicy.

Overloads 
def delete_endpoint_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_endpoint_policy via a request object, either of type DeleteEndpointPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteEndpointPolicyRequest, ::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_endpoint_policy(name: nil) -> ::Gapic::Operation
Pass arguments to delete_endpoint_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. A name of the EndpointPolicy to delete. Must be in the format projects/*/locations/global/endpointPolicies/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_endpoint_policy method.
result = client.delete_endpoint_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_gateway

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

Deletes a single Gateway.

Overloads 
def delete_gateway(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_gateway via a request object, either of type DeleteGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteGatewayRequest, ::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_gateway(name: nil) -> ::Gapic::Operation
Pass arguments to delete_gateway 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. A name of the Gateway to delete. Must be in the format projects/*/locations/*/gateways/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_gateway method.
result = client.delete_gateway 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_grpc_route

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

Deletes a single GrpcRoute.

Overloads 
def delete_grpc_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_grpc_route via a request object, either of type DeleteGrpcRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteGrpcRouteRequest, ::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_grpc_route(name: nil) -> ::Gapic::Operation
Pass arguments to delete_grpc_route 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. A name of the GrpcRoute to delete. Must be in the format projects/*/locations/global/grpcRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_grpc_route method.
result = client.delete_grpc_route 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_http_route

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

Deletes a single HttpRoute.

Overloads 
def delete_http_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_http_route via a request object, either of type DeleteHttpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteHttpRouteRequest, ::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_http_route(name: nil) -> ::Gapic::Operation
Pass arguments to delete_http_route 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. A name of the HttpRoute to delete. Must be in the format projects/*/locations/global/httpRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_http_route method.
result = client.delete_http_route 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_mesh

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

Deletes a single Mesh.

Overloads 
def delete_mesh(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_mesh via a request object, either of type DeleteMeshRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteMeshRequest, ::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_mesh(name: nil) -> ::Gapic::Operation
Pass arguments to delete_mesh 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. A name of the Mesh to delete. Must be in the format projects/*/locations/global/meshes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_mesh method.
result = client.delete_mesh 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_service_binding

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

Deletes a single ServiceBinding.

Overloads 
def delete_service_binding(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_service_binding via a request object, either of type DeleteServiceBindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteServiceBindingRequest, ::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_service_binding(name: nil) -> ::Gapic::Operation
Pass arguments to delete_service_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. A name of the ServiceBinding to delete. Must be in the format projects/*/locations/global/serviceBindings/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_service_binding method.
result = client.delete_service_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_tcp_route

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

Deletes a single TcpRoute.

Overloads 
def delete_tcp_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_tcp_route via a request object, either of type DeleteTcpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteTcpRouteRequest, ::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_tcp_route(name: nil) -> ::Gapic::Operation
Pass arguments to delete_tcp_route 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. A name of the TcpRoute to delete. Must be in the format projects/*/locations/global/tcpRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_tcp_route method.
result = client.delete_tcp_route 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_tls_route

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

Deletes a single TlsRoute.

Overloads 
def delete_tls_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_tls_route via a request object, either of type DeleteTlsRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::DeleteTlsRouteRequest, ::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_tls_route(name: nil) -> ::Gapic::Operation
Pass arguments to delete_tls_route 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. A name of the TlsRoute to delete. Must be in the format projects/*/locations/global/tlsRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the delete_tls_route method.
result = client.delete_tls_route 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

#get_endpoint_policy

def get_endpoint_policy(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::EndpointPolicy
def get_endpoint_policy(name: nil) -> ::Google::Cloud::NetworkServices::V1::EndpointPolicy

Gets details of a single EndpointPolicy.

Overloads 
def get_endpoint_policy(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::EndpointPolicy
Pass arguments to get_endpoint_policy via a request object, either of type GetEndpointPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetEndpointPolicyRequest, ::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_endpoint_policy(name: nil) -> ::Google::Cloud::NetworkServices::V1::EndpointPolicy
Pass arguments to get_endpoint_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. A name of the EndpointPolicy to get. Must be in the format projects/*/locations/global/endpointPolicies/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::EndpointPolicy.
p result

#get_gateway

def get_gateway(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::Gateway
def get_gateway(name: nil) -> ::Google::Cloud::NetworkServices::V1::Gateway

Gets details of a single Gateway.

Overloads 
def get_gateway(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::Gateway
Pass arguments to get_gateway via a request object, either of type GetGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetGatewayRequest, ::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_gateway(name: nil) -> ::Google::Cloud::NetworkServices::V1::Gateway
Pass arguments to get_gateway 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. A name of the Gateway to get. Must be in the format projects/*/locations/*/gateways/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::Gateway.
p result

#get_grpc_route

def get_grpc_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::GrpcRoute
def get_grpc_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::GrpcRoute

Gets details of a single GrpcRoute.

Overloads 
def get_grpc_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::GrpcRoute
Pass arguments to get_grpc_route via a request object, either of type GetGrpcRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetGrpcRouteRequest, ::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_grpc_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::GrpcRoute
Pass arguments to get_grpc_route 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. A name of the GrpcRoute to get. Must be in the format projects/*/locations/global/grpcRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::GrpcRoute.
p result

#get_http_route

def get_http_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::HttpRoute
def get_http_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::HttpRoute

Gets details of a single HttpRoute.

Overloads 
def get_http_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::HttpRoute
Pass arguments to get_http_route via a request object, either of type GetHttpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetHttpRouteRequest, ::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_http_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::HttpRoute
Pass arguments to get_http_route 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. A name of the HttpRoute to get. Must be in the format projects/*/locations/global/httpRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::HttpRoute.
p result

#get_mesh

def get_mesh(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::Mesh
def get_mesh(name: nil) -> ::Google::Cloud::NetworkServices::V1::Mesh

Gets details of a single Mesh.

Overloads 
def get_mesh(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::Mesh
Pass arguments to get_mesh via a request object, either of type GetMeshRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetMeshRequest, ::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_mesh(name: nil) -> ::Google::Cloud::NetworkServices::V1::Mesh
Pass arguments to get_mesh 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. A name of the Mesh to get. Must be in the format projects/*/locations/global/meshes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::Mesh.
p result

#get_service_binding

def get_service_binding(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::ServiceBinding
def get_service_binding(name: nil) -> ::Google::Cloud::NetworkServices::V1::ServiceBinding

Gets details of a single ServiceBinding.

Overloads 
def get_service_binding(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::ServiceBinding
Pass arguments to get_service_binding via a request object, either of type GetServiceBindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetServiceBindingRequest, ::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_service_binding(name: nil) -> ::Google::Cloud::NetworkServices::V1::ServiceBinding
Pass arguments to get_service_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. A name of the ServiceBinding to get. Must be in the format projects/*/locations/global/serviceBindings/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::ServiceBinding.
p result

#get_tcp_route

def get_tcp_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::TcpRoute
def get_tcp_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::TcpRoute

Gets details of a single TcpRoute.

Overloads 
def get_tcp_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::TcpRoute
Pass arguments to get_tcp_route via a request object, either of type GetTcpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetTcpRouteRequest, ::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_tcp_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::TcpRoute
Pass arguments to get_tcp_route 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. A name of the TcpRoute to get. Must be in the format projects/*/locations/global/tcpRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::TcpRoute.
p result

#get_tls_route

def get_tls_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::TlsRoute
def get_tls_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::TlsRoute

Gets details of a single TlsRoute.

Overloads 
def get_tls_route(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::TlsRoute
Pass arguments to get_tls_route via a request object, either of type GetTlsRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::GetTlsRouteRequest, ::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_tls_route(name: nil) -> ::Google::Cloud::NetworkServices::V1::TlsRoute
Pass arguments to get_tls_route 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. A name of the TlsRoute to get. Must be in the format projects/*/locations/global/tlsRoutes/*.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkServices::V1::TlsRoute.
p result

#iam_policy_client

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

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

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

#initialize

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

Create a new NetworkServices REST client object.

Yields
  • (config) — Configure the NetworkServices client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::NetworkServices::V1::NetworkServices::Rest::Client.new

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

#list_endpoint_policies

def list_endpoint_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::EndpointPolicy>
def list_endpoint_policies(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::EndpointPolicy>

Lists EndpointPolicies in a given project and location.

Overloads 
def list_endpoint_policies(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::EndpointPolicy>
Pass arguments to list_endpoint_policies via a request object, either of type ListEndpointPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListEndpointPoliciesRequest, ::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_endpoint_policies(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::EndpointPolicy>
Pass arguments to list_endpoint_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 project and location from which the EndpointPolicies should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of EndpointPolicies to return per call.
  • page_token (::String) — The value returned by the last ListEndpointPoliciesResponse Indicates that this is a continuation of a prior ListEndpointPolicies call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_endpoint_policies method.
result = client.list_endpoint_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::NetworkServices::V1::EndpointPolicy.
  p item
end

#list_gateways

def list_gateways(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Gateway>
def list_gateways(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Gateway>

Lists Gateways in a given project and location.

Overloads 
def list_gateways(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Gateway>
Pass arguments to list_gateways via a request object, either of type ListGatewaysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListGatewaysRequest, ::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_gateways(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Gateway>
Pass arguments to list_gateways 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 project and location from which the Gateways should be listed, specified in the format projects/*/locations/*.
  • page_size (::Integer) — Maximum number of Gateways to return per call.
  • page_token (::String) — The value returned by the last ListGatewaysResponse Indicates that this is a continuation of a prior ListGateways call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_gateways method.
result = client.list_gateways 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::NetworkServices::V1::Gateway.
  p item
end

#list_grpc_routes

def list_grpc_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::GrpcRoute>
def list_grpc_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::GrpcRoute>

Lists GrpcRoutes in a given project and location.

Overloads 
def list_grpc_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::GrpcRoute>
Pass arguments to list_grpc_routes via a request object, either of type ListGrpcRoutesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListGrpcRoutesRequest, ::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_grpc_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::GrpcRoute>
Pass arguments to list_grpc_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 project and location from which the GrpcRoutes should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of GrpcRoutes to return per call.
  • page_token (::String) — The value returned by the last ListGrpcRoutesResponse Indicates that this is a continuation of a prior ListGrpcRoutes call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_grpc_routes method.
result = client.list_grpc_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::NetworkServices::V1::GrpcRoute.
  p item
end

#list_http_routes

def list_http_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::HttpRoute>
def list_http_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::HttpRoute>

Lists HttpRoute in a given project and location.

Overloads 
def list_http_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::HttpRoute>
Pass arguments to list_http_routes via a request object, either of type ListHttpRoutesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListHttpRoutesRequest, ::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_http_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::HttpRoute>
Pass arguments to list_http_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 project and location from which the HttpRoutes should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of HttpRoutes to return per call.
  • page_token (::String) — The value returned by the last ListHttpRoutesResponse Indicates that this is a continuation of a prior ListHttpRoutes call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_http_routes method.
result = client.list_http_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::NetworkServices::V1::HttpRoute.
  p item
end

#list_meshes

def list_meshes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Mesh>
def list_meshes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Mesh>

Lists Meshes in a given project and location.

Overloads 
def list_meshes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Mesh>
Pass arguments to list_meshes via a request object, either of type ListMeshesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListMeshesRequest, ::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_meshes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::Mesh>
Pass arguments to list_meshes 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 project and location from which the Meshes should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of Meshes to return per call.
  • page_token (::String) — The value returned by the last ListMeshesResponse Indicates that this is a continuation of a prior ListMeshes call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_meshes method.
result = client.list_meshes 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::NetworkServices::V1::Mesh.
  p item
end

#list_service_bindings

def list_service_bindings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::ServiceBinding>
def list_service_bindings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::ServiceBinding>

Lists ServiceBinding in a given project and location.

Overloads 
def list_service_bindings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::ServiceBinding>
Pass arguments to list_service_bindings via a request object, either of type ListServiceBindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListServiceBindingsRequest, ::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_service_bindings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::ServiceBinding>
Pass arguments to list_service_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 project and location from which the ServiceBindings should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of ServiceBindings to return per call.
  • page_token (::String) — The value returned by the last ListServiceBindingsResponse Indicates that this is a continuation of a prior ListRouters call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_service_bindings method.
result = client.list_service_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::NetworkServices::V1::ServiceBinding.
  p item
end

#list_tcp_routes

def list_tcp_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TcpRoute>
def list_tcp_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TcpRoute>

Lists TcpRoute in a given project and location.

Overloads 
def list_tcp_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TcpRoute>
Pass arguments to list_tcp_routes via a request object, either of type ListTcpRoutesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListTcpRoutesRequest, ::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_tcp_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TcpRoute>
Pass arguments to list_tcp_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 project and location from which the TcpRoutes should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of TcpRoutes to return per call.
  • page_token (::String) — The value returned by the last ListTcpRoutesResponse Indicates that this is a continuation of a prior ListTcpRoutes call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_tcp_routes method.
result = client.list_tcp_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::NetworkServices::V1::TcpRoute.
  p item
end

#list_tls_routes

def list_tls_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TlsRoute>
def list_tls_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TlsRoute>

Lists TlsRoute in a given project and location.

Overloads 
def list_tls_routes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TlsRoute>
Pass arguments to list_tls_routes via a request object, either of type ListTlsRoutesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::ListTlsRoutesRequest, ::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_tls_routes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkServices::V1::TlsRoute>
Pass arguments to list_tls_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 project and location from which the TlsRoutes should be listed, specified in the format projects/*/locations/global.
  • page_size (::Integer) — Maximum number of TlsRoutes to return per call.
  • page_token (::String) — The value returned by the last ListTlsRoutesResponse Indicates that this is a continuation of a prior ListTlsRoutes call, and that the system should return the next page of data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the list_tls_routes method.
result = client.list_tls_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::NetworkServices::V1::TlsRoute.
  p item
end

#location_client

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

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

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

#operations_client

def operations_client() -> ::Google::Cloud::NetworkServices::V1::NetworkServices::Rest::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_endpoint_policy

def update_endpoint_policy(request, options = nil) -> ::Gapic::Operation
def update_endpoint_policy(update_mask: nil, endpoint_policy: nil) -> ::Gapic::Operation

Updates the parameters of a single EndpointPolicy.

Overloads 
def update_endpoint_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_endpoint_policy via a request object, either of type UpdateEndpointPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateEndpointPolicyRequest, ::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_endpoint_policy(update_mask: nil, endpoint_policy: nil) -> ::Gapic::Operation
Pass arguments to update_endpoint_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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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.
  • endpoint_policy (::Google::Cloud::NetworkServices::V1::EndpointPolicy, ::Hash) — Required. Updated EndpointPolicy resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_endpoint_policy method.
result = client.update_endpoint_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_gateway

def update_gateway(request, options = nil) -> ::Gapic::Operation
def update_gateway(update_mask: nil, gateway: nil) -> ::Gapic::Operation

Updates the parameters of a single Gateway.

Overloads 
def update_gateway(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_gateway via a request object, either of type UpdateGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateGatewayRequest, ::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_gateway(update_mask: nil, gateway: nil) -> ::Gapic::Operation
Pass arguments to update_gateway 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) — Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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.
  • gateway (::Google::Cloud::NetworkServices::V1::Gateway, ::Hash) — Required. Updated Gateway resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_gateway method.
result = client.update_gateway 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_grpc_route

def update_grpc_route(request, options = nil) -> ::Gapic::Operation
def update_grpc_route(update_mask: nil, grpc_route: nil) -> ::Gapic::Operation

Updates the parameters of a single GrpcRoute.

Overloads 
def update_grpc_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_grpc_route via a request object, either of type UpdateGrpcRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateGrpcRouteRequest, ::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_grpc_route(update_mask: nil, grpc_route: nil) -> ::Gapic::Operation
Pass arguments to update_grpc_route 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) — Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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.
  • grpc_route (::Google::Cloud::NetworkServices::V1::GrpcRoute, ::Hash) — Required. Updated GrpcRoute resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_grpc_route method.
result = client.update_grpc_route 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_http_route

def update_http_route(request, options = nil) -> ::Gapic::Operation
def update_http_route(update_mask: nil, http_route: nil) -> ::Gapic::Operation

Updates the parameters of a single HttpRoute.

Overloads 
def update_http_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_http_route via a request object, either of type UpdateHttpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateHttpRouteRequest, ::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_http_route(update_mask: nil, http_route: nil) -> ::Gapic::Operation
Pass arguments to update_http_route 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) — Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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.
  • http_route (::Google::Cloud::NetworkServices::V1::HttpRoute, ::Hash) — Required. Updated HttpRoute resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_http_route method.
result = client.update_http_route 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_mesh

def update_mesh(request, options = nil) -> ::Gapic::Operation
def update_mesh(update_mask: nil, mesh: nil) -> ::Gapic::Operation

Updates the parameters of a single Mesh.

Overloads 
def update_mesh(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_mesh via a request object, either of type UpdateMeshRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateMeshRequest, ::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_mesh(update_mask: nil, mesh: nil) -> ::Gapic::Operation
Pass arguments to update_mesh 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) — Optional. Field mask is used to specify the fields to be overwritten in the Mesh 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.
  • mesh (::Google::Cloud::NetworkServices::V1::Mesh, ::Hash) — Required. Updated Mesh resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_mesh method.
result = client.update_mesh 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_tcp_route

def update_tcp_route(request, options = nil) -> ::Gapic::Operation
def update_tcp_route(update_mask: nil, tcp_route: nil) -> ::Gapic::Operation

Updates the parameters of a single TcpRoute.

Overloads 
def update_tcp_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_tcp_route via a request object, either of type UpdateTcpRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateTcpRouteRequest, ::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_tcp_route(update_mask: nil, tcp_route: nil) -> ::Gapic::Operation
Pass arguments to update_tcp_route 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) — Optional. Field mask is used to specify the fields to be overwritten in the TcpRoute 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.
  • tcp_route (::Google::Cloud::NetworkServices::V1::TcpRoute, ::Hash) — Required. Updated TcpRoute resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_tcp_route method.
result = client.update_tcp_route 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_tls_route

def update_tls_route(request, options = nil) -> ::Gapic::Operation
def update_tls_route(update_mask: nil, tls_route: nil) -> ::Gapic::Operation

Updates the parameters of a single TlsRoute.

Overloads 
def update_tls_route(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_tls_route via a request object, either of type UpdateTlsRouteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkServices::V1::UpdateTlsRouteRequest, ::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_tls_route(update_mask: nil, tls_route: nil) -> ::Gapic::Operation
Pass arguments to update_tls_route 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) — Optional. Field mask is used to specify the fields to be overwritten in the TlsRoute 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.
  • tls_route (::Google::Cloud::NetworkServices::V1::TlsRoute, ::Hash) — Required. Updated TlsRoute resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/network_services/v1"

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

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

# Call the update_tls_route method.
result = client.update_tls_route 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