Class: Google::Cloud::Compute::V1::TargetHttpsProxies::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb

Overview

REST client for the TargetHttpsProxies service.

The TargetHttpsProxies API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new TargetHttpsProxies REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the TargetHttpsProxies client.

Yield Parameters:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 138

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

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

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @target_https_proxies_stub = ::Google::Cloud::Compute::V1::TargetHttpsProxies::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Class Method Details

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

Configure the TargetHttpsProxies Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 56

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Compute", "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.rpcs.aggregated_list.timeout = 600.0
    default_config.rpcs.aggregated_list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete.timeout = 600.0

    default_config.rpcs.get.timeout = 600.0
    default_config.rpcs.get.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.insert.timeout = 600.0

    default_config.rpcs.list.timeout = 600.0
    default_config.rpcs.list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.patch.timeout = 600.0

    default_config.rpcs.set_quic_override.timeout = 600.0

    default_config.rpcs.set_ssl_certificates.timeout = 600.0

    default_config.rpcs.set_ssl_policy.timeout = 600.0

    default_config.rpcs.set_url_map.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#aggregated_list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetHttpsProxiesScopedList> #aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetHttpsProxiesScopedList>

Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

Overloads:

  • #aggregated_list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetHttpsProxiesScopedList>

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::AggregatedListTargetHttpsProxiesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetHttpsProxiesScopedList>

    Pass arguments to aggregated_list 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:

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

      A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

    • include_all_scopes (::Boolean) (defaults to: nil) —

      Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

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

      The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

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

      Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

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

      Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

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

      Name of the project scoping this request.

    • return_partial_success (::Boolean) (defaults to: nil) —

      Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 198

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListTargetHttpsProxiesRequest

  # 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
  call_metadata = @config.rpcs.aggregated_list.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.aggregated_list.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.aggregated_list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @target_https_proxies_stub, :aggregated_list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

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

Configure the TargetHttpsProxies 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:



117
118
119
120
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 117

def configure
  yield @config if block_given?
  @config
end

#delete(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #delete(project: nil, request_id: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

Deletes the specified TargetHttpsProxy resource.

Overloads:

  • #delete(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::DeleteTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #delete(project: nil, request_id: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to delete 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

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

      Name of the TargetHttpsProxy resource to delete.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 264

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.delete.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.delete.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.delete request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::TargetHttpsProxy #get(project: nil, target_https_proxy: nil) ⇒ ::Google::Cloud::Compute::V1::TargetHttpsProxy

Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.

Overloads:

  • #get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::TargetHttpsProxy

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #get(project: nil, target_https_proxy: nil) ⇒ ::Google::Cloud::Compute::V1::TargetHttpsProxy

    Pass arguments to get 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:

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

      Project ID for this request.

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

      Name of the TargetHttpsProxy resource to return.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 328

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.get.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.get request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#insert(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #insert(project: nil, request_id: nil, target_https_proxy_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Overloads:

  • #insert(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::InsertTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #insert(project: nil, request_id: nil, target_https_proxy_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to insert 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

    • target_https_proxy_resource (::Google::Cloud::Compute::V1::TargetHttpsProxy, ::Hash) (defaults to: nil) —

      The body resource for this request

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



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
422
423
424
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 393

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.insert.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.insert.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.insert request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetHttpsProxy> #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetHttpsProxy>

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Overloads:

  • #list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetHttpsProxy>

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::ListTargetHttpsProxiesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetHttpsProxy>

    Pass arguments to list 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:

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

      A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

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

      The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

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

      Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

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

      Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

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

      Project ID for this request.

    • return_partial_success (::Boolean) (defaults to: nil) —

      Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 465

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListTargetHttpsProxiesRequest

  # 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
  call_metadata = @config.rpcs.list.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.list.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @target_https_proxies_stub, :list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#patch(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #patch(project: nil, request_id: nil, target_https_proxy: nil, target_https_proxy_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Overloads:

  • #patch(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::PatchTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #patch(project: nil, request_id: nil, target_https_proxy: nil, target_https_proxy_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to patch 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

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

      Name of the TargetHttpsProxy resource to patch.

    • target_https_proxy_resource (::Google::Cloud::Compute::V1::TargetHttpsProxy, ::Hash) (defaults to: nil) —

      The body resource for this request

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 533

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.patch.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.patch.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.patch request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#set_quic_override(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_quic_override(project: nil, request_id: nil, target_https_proxies_set_quic_override_request_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

Sets the QUIC override policy for TargetHttpsProxy.

Overloads:

  • #set_quic_override(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::SetQuicOverrideTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #set_quic_override(project: nil, request_id: nil, target_https_proxies_set_quic_override_request_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to set_quic_override 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

    • target_https_proxies_set_quic_override_request_resource (::Google::Cloud::Compute::V1::TargetHttpsProxiesSetQuicOverrideRequest, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 601

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetQuicOverrideTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.set_quic_override.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_quic_override.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.set_quic_override request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#set_ssl_certificates(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_ssl_certificates(project: nil, request_id: nil, target_https_proxies_set_ssl_certificates_request_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

Replaces SslCertificates for TargetHttpsProxy.

Overloads:

  • #set_ssl_certificates(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::SetSslCertificatesTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #set_ssl_certificates(project: nil, request_id: nil, target_https_proxies_set_ssl_certificates_request_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to set_ssl_certificates 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

    • target_https_proxies_set_ssl_certificates_request_resource (::Google::Cloud::Compute::V1::TargetHttpsProxiesSetSslCertificatesRequest, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Name of the TargetHttpsProxy resource to set an SslCertificates resource for.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 669

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetSslCertificatesTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.set_ssl_certificates.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_ssl_certificates.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.set_ssl_certificates request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#set_ssl_policy(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_ssl_policy(project: nil, request_id: nil, ssl_policy_reference_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

Overloads:

  • #set_ssl_policy(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::SetSslPolicyTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #set_ssl_policy(project: nil, request_id: nil, ssl_policy_reference_resource: nil, target_https_proxy: nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

    • ssl_policy_reference_resource (::Google::Cloud::Compute::V1::SslPolicyReference, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 737

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetSslPolicyTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.set_ssl_policy.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_ssl_policy.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.set_ssl_policy request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end

#set_url_map(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #set_url_map(project: nil, request_id: nil, target_https_proxy: nil, url_map_reference_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

Changes the URL map for TargetHttpsProxy.

Overloads:

  • #set_url_map(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::SetUrlMapTargetHttpsProxyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #set_url_map(project: nil, request_id: nil, target_https_proxy: nil, url_map_reference_resource: nil) ⇒ ::Gapic::Rest::BaseOperation

    Pass arguments to set_url_map 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:

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

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

      Name of the TargetHttpsProxy resource whose URL map is to be set.

    • url_map_reference_resource (::Google::Cloud::Compute::V1::UrlMapReference, ::Hash) (defaults to: nil) —

      The body resource for this request

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::Rest::BaseOperation)

Raises:

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

    if the REST call is aborted.



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/google/cloud/compute/v1/target_https_proxies/rest/client.rb', line 805

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetUrlMapTargetHttpsProxyRequest

  # 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
  call_metadata = @config.rpcs.set_url_map.metadata.to_h

  # Set x-goog-api-client header
  call_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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_url_map.timeout,
                         metadata:     call_metadata

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

  @target_https_proxies_stub.set_url_map request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end