Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::DepService::Client.
Client for the DepService service.
Service describing handlers for resources.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DepService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DepService clients ::Google::Cloud::NetworkServices::V1::DepService::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the DepService 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_lb_route_extension
def create_lb_route_extension(request, options = nil) -> ::Gapic::Operation
def create_lb_route_extension(parent: nil, lb_route_extension_id: nil, lb_route_extension: nil, request_id: nil) -> ::Gapic::Operation
Creates a new LbRouteExtension
resource in a given project and location.
def create_lb_route_extension(request, options = nil) -> ::Gapic::Operation
create_lb_route_extension
via a request object, either of type
CreateLbRouteExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::CreateLbRouteExtensionRequest, ::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_lb_route_extension(parent: nil, lb_route_extension_id: nil, lb_route_extension: nil, request_id: nil) -> ::Gapic::Operation
create_lb_route_extension
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).
-
parent (::String) — Required. The parent resource of the
LbRouteExtension
resource. Must be in the formatprojects/{project}/locations/{location}
. -
lb_route_extension_id (::String) — Required. User-provided ID of the
LbRouteExtension
resource to be created. -
lb_route_extension (::Google::Cloud::NetworkServices::V1::LbRouteExtension, ::Hash) — Required.
LbRouteExtension
resource to be created. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::CreateLbRouteExtensionRequest.new # Call the create_lb_route_extension method. result = client.create_lb_route_extension 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_lb_traffic_extension
def create_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
def create_lb_traffic_extension(parent: nil, lb_traffic_extension_id: nil, lb_traffic_extension: nil, request_id: nil) -> ::Gapic::Operation
Creates a new LbTrafficExtension
resource in a given project and
location.
def create_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
create_lb_traffic_extension
via a request object, either of type
CreateLbTrafficExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::CreateLbTrafficExtensionRequest, ::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_lb_traffic_extension(parent: nil, lb_traffic_extension_id: nil, lb_traffic_extension: nil, request_id: nil) -> ::Gapic::Operation
create_lb_traffic_extension
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).
-
parent (::String) — Required. The parent resource of the
LbTrafficExtension
resource. Must be in the formatprojects/{project}/locations/{location}
. -
lb_traffic_extension_id (::String) — Required. User-provided ID of the
LbTrafficExtension
resource to be created. -
lb_traffic_extension (::Google::Cloud::NetworkServices::V1::LbTrafficExtension, ::Hash) — Required.
LbTrafficExtension
resource to be created. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::CreateLbTrafficExtensionRequest.new # Call the create_lb_traffic_extension method. result = client.create_lb_traffic_extension 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_lb_route_extension
def delete_lb_route_extension(request, options = nil) -> ::Gapic::Operation
def delete_lb_route_extension(name: nil, request_id: nil) -> ::Gapic::Operation
Deletes the specified LbRouteExtension
resource.
def delete_lb_route_extension(request, options = nil) -> ::Gapic::Operation
delete_lb_route_extension
via a request object, either of type
Google::Cloud::NetworkServices::V1::DeleteLbRouteExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::DeleteLbRouteExtensionRequest, ::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_lb_route_extension(name: nil, request_id: nil) -> ::Gapic::Operation
delete_lb_route_extension
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).
-
name (::String) — Required. The name of the
LbRouteExtension
resource to delete. Must be in the formatprojects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}
. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::DeleteLbRouteExtensionRequest.new # Call the delete_lb_route_extension method. result = client.delete_lb_route_extension 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_lb_traffic_extension
def delete_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
def delete_lb_traffic_extension(name: nil, request_id: nil) -> ::Gapic::Operation
Deletes the specified LbTrafficExtension
resource.
def delete_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
delete_lb_traffic_extension
via a request object, either of type
Google::Cloud::NetworkServices::V1::DeleteLbTrafficExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::DeleteLbTrafficExtensionRequest, ::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_lb_traffic_extension(name: nil, request_id: nil) -> ::Gapic::Operation
delete_lb_traffic_extension
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).
-
name (::String) — Required. The name of the
LbTrafficExtension
resource to delete. Must be in the formatprojects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}
. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::DeleteLbTrafficExtensionRequest.new # Call the delete_lb_traffic_extension method. result = client.delete_lb_traffic_extension 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_lb_route_extension
def get_lb_route_extension(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::LbRouteExtension
def get_lb_route_extension(name: nil) -> ::Google::Cloud::NetworkServices::V1::LbRouteExtension
Gets details of the specified LbRouteExtension
resource.
def get_lb_route_extension(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::LbRouteExtension
get_lb_route_extension
via a request object, either of type
GetLbRouteExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::GetLbRouteExtensionRequest, ::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_lb_route_extension(name: nil) -> ::Google::Cloud::NetworkServices::V1::LbRouteExtension
get_lb_route_extension
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).
-
name (::String) — Required. A name of the
LbRouteExtension
resource to get. Must be in the formatprojects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::NetworkServices::V1::LbRouteExtension)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::GetLbRouteExtensionRequest.new # Call the get_lb_route_extension method. result = client.get_lb_route_extension request # The returned object is of type Google::Cloud::NetworkServices::V1::LbRouteExtension. p result
#get_lb_traffic_extension
def get_lb_traffic_extension(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::LbTrafficExtension
def get_lb_traffic_extension(name: nil) -> ::Google::Cloud::NetworkServices::V1::LbTrafficExtension
Gets details of the specified LbTrafficExtension
resource.
def get_lb_traffic_extension(request, options = nil) -> ::Google::Cloud::NetworkServices::V1::LbTrafficExtension
get_lb_traffic_extension
via a request object, either of type
GetLbTrafficExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::GetLbTrafficExtensionRequest, ::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_lb_traffic_extension(name: nil) -> ::Google::Cloud::NetworkServices::V1::LbTrafficExtension
get_lb_traffic_extension
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).
-
name (::String) — Required. A name of the
LbTrafficExtension
resource to get. Must be in the formatprojects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::NetworkServices::V1::LbTrafficExtension)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::GetLbTrafficExtensionRequest.new # Call the get_lb_traffic_extension method. result = client.get_lb_traffic_extension request # The returned object is of type Google::Cloud::NetworkServices::V1::LbTrafficExtension. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new DepService client object.
- (config) — Configure the DepService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::NetworkServices::V1::DepService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::NetworkServices::V1::DepService::Client.new do |config| config.timeout = 10.0 end
#list_lb_route_extensions
def list_lb_route_extensions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>
def list_lb_route_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>
Lists LbRouteExtension
resources in a given project and location.
def list_lb_route_extensions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>
list_lb_route_extensions
via a request object, either of type
ListLbRouteExtensionsRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::ListLbRouteExtensionsRequest, ::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_lb_route_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>
list_lb_route_extensions
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).
-
parent (::String) — Required. The project and location from which the
LbRouteExtension
resources are listed, specified in the following format:projects/{project}/locations/{location}
. - page_size (::Integer) — Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
- page_token (::String) — Optional. A token identifying a page of results that the server returns.
- filter (::String) — Optional. Filtering results.
- order_by (::String) — Optional. Hint for how to order the results.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::ListLbRouteExtensionsRequest.new # Call the list_lb_route_extensions method. result = client.list_lb_route_extensions 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::LbRouteExtension. p item end
#list_lb_traffic_extensions
def list_lb_traffic_extensions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>
def list_lb_traffic_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>
Lists LbTrafficExtension
resources in a given project and location.
def list_lb_traffic_extensions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>
list_lb_traffic_extensions
via a request object, either of type
ListLbTrafficExtensionsRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::ListLbTrafficExtensionsRequest, ::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_lb_traffic_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>
list_lb_traffic_extensions
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).
-
parent (::String) — Required. The project and location from which the
LbTrafficExtension
resources are listed, specified in the following format:projects/{project}/locations/{location}
. - page_size (::Integer) — Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
- page_token (::String) — Optional. A token identifying a page of results that the server returns.
- filter (::String) — Optional. Filtering results.
- order_by (::String) — Optional. Hint for how to order the results.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::ListLbTrafficExtensionsRequest.new # Call the list_lb_traffic_extensions method. result = client.list_lb_traffic_extensions 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::LbTrafficExtension. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::NetworkServices::V1::DepService::Operations
Get the associated client for long-running operations.
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_lb_route_extension
def update_lb_route_extension(request, options = nil) -> ::Gapic::Operation
def update_lb_route_extension(update_mask: nil, lb_route_extension: nil, request_id: nil) -> ::Gapic::Operation
Updates the parameters of the specified LbRouteExtension
resource.
def update_lb_route_extension(request, options = nil) -> ::Gapic::Operation
update_lb_route_extension
via a request object, either of type
UpdateLbRouteExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::UpdateLbRouteExtensionRequest, ::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_lb_route_extension(update_mask: nil, lb_route_extension: nil, request_id: nil) -> ::Gapic::Operation
update_lb_route_extension
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).
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Used to specify the fields to be overwritten in the
LbRouteExtension
resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. -
lb_route_extension (::Google::Cloud::NetworkServices::V1::LbRouteExtension, ::Hash) — Required.
LbRouteExtension
resource being updated. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::UpdateLbRouteExtensionRequest.new # Call the update_lb_route_extension method. result = client.update_lb_route_extension 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_lb_traffic_extension
def update_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
def update_lb_traffic_extension(update_mask: nil, lb_traffic_extension: nil, request_id: nil) -> ::Gapic::Operation
Updates the parameters of the specified LbTrafficExtension
resource.
def update_lb_traffic_extension(request, options = nil) -> ::Gapic::Operation
update_lb_traffic_extension
via a request object, either of type
UpdateLbTrafficExtensionRequest or an equivalent Hash.
- request (::Google::Cloud::NetworkServices::V1::UpdateLbTrafficExtensionRequest, ::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_lb_traffic_extension(update_mask: nil, lb_traffic_extension: nil, request_id: nil) -> ::Gapic::Operation
update_lb_traffic_extension
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).
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Used to specify the fields to be overwritten in the
LbTrafficExtension
resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. -
lb_traffic_extension (::Google::Cloud::NetworkServices::V1::LbTrafficExtension, ::Hash) — Required.
LbTrafficExtension
resource being updated. -
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server can ignore
the request if it has already been completed. The server guarantees
that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::DepService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::NetworkServices::V1::UpdateLbTrafficExtensionRequest.new # Call the update_lb_traffic_extension method. result = client.update_lb_traffic_extension 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