Class: Google::Cloud::NetworkServices::V1::DepService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/network_services/v1/dep_service/client.rb

Overview

Client for the DepService service.

Service describing handlers for resources.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#lb_route_extension_path, #lb_traffic_extension_path, #location_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DepService client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the DepService client.

Yield Parameters:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 128

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/networkservices/v1/dep_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @dep_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::NetworkServices::V1::DepService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @dep_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dep_service_stub.endpoint
    config.universe_domain = @dep_service_stub.universe_domain
    config.logger = @dep_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dep_service_stub.endpoint
    config.universe_domain = @dep_service_stub.universe_domain
    config.logger = @dep_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

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

Returns:

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


221
222
223
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 221

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


214
215
216
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 214

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::NetworkServices::V1::DepService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



207
208
209
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 207

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DepService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "NetworkServices", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



98
99
100
101
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#create_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #create_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_lb_route_extension(parent: nil, lb_route_extension_id: nil, lb_route_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the LbRouteExtension resource. Must be in the format projects/{project}/locations/{location}.

    • lb_route_extension_id (::String) (defaults to: nil) —

      Required. User-provided ID of the LbRouteExtension resource to be created.

    • lb_route_extension (::Google::Cloud::NetworkServices::V1::LbRouteExtension, ::Hash) (defaults to: nil) —

      Required. LbRouteExtension resource to be created.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 1022

def create_lb_route_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::CreateLbRouteExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_lb_route_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_lb_route_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_lb_route_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :create_lb_route_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #create_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_lb_traffic_extension(parent: nil, lb_traffic_extension_id: nil, lb_traffic_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the LbTrafficExtension resource. Must be in the format projects/{project}/locations/{location}.

    • lb_traffic_extension_id (::String) (defaults to: nil) —

      Required. User-provided ID of the LbTrafficExtension resource to be created.

    • lb_traffic_extension (::Google::Cloud::NetworkServices::V1::LbTrafficExtension, ::Hash) (defaults to: nil) —

      Required. LbTrafficExtension resource to be created.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 495

def create_lb_traffic_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::CreateLbTrafficExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_lb_traffic_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_lb_traffic_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_lb_traffic_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :create_lb_traffic_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation #delete_lb_route_extension(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes the specified LbRouteExtension resource.

Examples:

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

Overloads:

  • #delete_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_lb_route_extension via a request object, either of type Google::Cloud::NetworkServices::V1::DeleteLbRouteExtensionRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_lb_route_extension(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the LbRouteExtension resource to delete. Must be in the format projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 1246

def delete_lb_route_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::DeleteLbRouteExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_lb_route_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_lb_route_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_lb_route_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :delete_lb_route_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation #delete_lb_traffic_extension(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes the specified LbTrafficExtension resource.

Examples:

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

Overloads:

  • #delete_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_lb_traffic_extension via a request object, either of type Google::Cloud::NetworkServices::V1::DeleteLbTrafficExtensionRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_lb_traffic_extension(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the LbTrafficExtension resource to delete. Must be in the format projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 719

def delete_lb_traffic_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::DeleteLbTrafficExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_lb_traffic_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_lb_traffic_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_lb_traffic_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :delete_lb_traffic_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_lb_route_extension(request, options = nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbRouteExtension #get_lb_route_extension(name: nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbRouteExtension

Gets details of the specified LbRouteExtension resource.

Examples:

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

Overloads:

  • #get_lb_route_extension(request, options = nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbRouteExtension

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_lb_route_extension(name: nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbRouteExtension

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the LbRouteExtension resource to get. Must be in the format projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 910

def get_lb_route_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::GetLbRouteExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_lb_route_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_lb_route_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_lb_route_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :get_lb_route_extension, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_lb_traffic_extension(request, options = nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbTrafficExtension #get_lb_traffic_extension(name: nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbTrafficExtension

Gets details of the specified LbTrafficExtension resource.

Examples:

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

Overloads:

  • #get_lb_traffic_extension(request, options = nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbTrafficExtension

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_lb_traffic_extension(name: nil) ⇒ ::Google::Cloud::NetworkServices::V1::LbTrafficExtension

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the LbTrafficExtension resource to get. Must be in the format projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 382

def get_lb_traffic_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::GetLbTrafficExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_lb_traffic_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_lb_traffic_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_lb_traffic_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :get_lb_traffic_extension, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_lb_route_extensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension> #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.

Examples:

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

Overloads:

  • #list_lb_route_extensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_lb_route_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbRouteExtension>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the LbRouteExtension resources are listed, specified in the following format: projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A token identifying a page of results that the server returns.

    • filter (::String) (defaults to: nil) —

      Optional. Filtering results.

    • order_by (::String) (defaults to: nil) —

      Optional. Hint for how to order the results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 821

def list_lb_route_extensions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::ListLbRouteExtensionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_lb_route_extensions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_lb_route_extensions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_lb_route_extensions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :list_lb_route_extensions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dep_service_stub, :list_lb_route_extensions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_lb_traffic_extensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension> #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.

Examples:

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

Overloads:

  • #list_lb_traffic_extensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_lb_traffic_extensions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkServices::V1::LbTrafficExtension>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the LbTrafficExtension resources are listed, specified in the following format: projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A token identifying a page of results that the server returns.

    • filter (::String) (defaults to: nil) —

      Optional. Filtering results.

    • order_by (::String) (defaults to: nil) —

      Optional. Hint for how to order the results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 293

def list_lb_traffic_extensions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::ListLbTrafficExtensionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_lb_traffic_extensions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_lb_traffic_extensions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_lb_traffic_extensions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :list_lb_traffic_extensions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dep_service_stub, :list_lb_traffic_extensions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


228
229
230
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 228

def logger
  @dep_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 108

def universe_domain
  @dep_service_stub.universe_domain
end

#update_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation #update_lb_route_extension(update_mask: nil, lb_route_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the parameters of the specified LbRouteExtension resource.

Examples:

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

Overloads:

  • #update_lb_route_extension(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_lb_route_extension(update_mask: nil, lb_route_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. 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) (defaults to: nil) —

      Required. LbRouteExtension resource being updated.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 1136

def update_lb_route_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::UpdateLbRouteExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_lb_route_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.lb_route_extension&.name
    header_params["lb_route_extension.name"] = request.lb_route_extension.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_lb_route_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_lb_route_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :update_lb_route_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation #update_lb_traffic_extension(update_mask: nil, lb_traffic_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the parameters of the specified LbTrafficExtension resource.

Examples:

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

Overloads:

  • #update_lb_traffic_extension(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_lb_traffic_extension(update_mask: nil, lb_traffic_extension: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. 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) (defaults to: nil) —

      Required. LbTrafficExtension resource being updated.

    • request_id (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/google/cloud/network_services/v1/dep_service/client.rb', line 609

def update_lb_traffic_extension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkServices::V1::UpdateLbTrafficExtensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_lb_traffic_extension.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkServices::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.lb_traffic_extension&.name
    header_params["lb_traffic_extension.name"] = request.lb_traffic_extension.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_lb_traffic_extension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_lb_traffic_extension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dep_service_stub.call_rpc :update_lb_traffic_extension, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end