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

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

Overview

REST client for the RegionNotificationEndpoints service.

The RegionNotificationEndpoints API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GrpcTranscoding

#transcode_delete, #transcode_get, #transcode_insert, #transcode_list

Constructor Details

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

Create a new RegionNotificationEndpoints REST client object.

Examples

To create a new RegionNotificationEndpoints REST client with the default configuration:

client = ::Google::Cloud::Compute::V1::RegionNotificationEndpoints::Rest::Client.new

To create a new RegionNotificationEndpoints REST client with a custom configuration:

client = ::Google::Cloud::Compute::V1::RegionNotificationEndpoints::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the RegionNotificationEndpoints client.

Yield Parameters:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 115

def initialize
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  # 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

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: @config.endpoint, credentials: credentials
end

Class Method Details

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

Configure the RegionNotificationEndpoints Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all RegionNotificationEndpoints clients:

::Google::Cloud::Compute::V1::RegionNotificationEndpoints::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 58

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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



90
91
92
93
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 90

def configure
  yield @config if block_given?
  @config
end

#delete(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Operation #delete(notification_endpoint: nil, project: nil, region: nil, request_id: nil) ⇒ ::Google::Cloud::Compute::V1::Operation

Deletes the specified NotificationEndpoint in the given region

Overloads:

  • #delete(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::DeleteRegionNotificationEndpointRequest, ::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(notification_endpoint: nil, project: nil, region: nil, request_id: nil) ⇒ ::Google::Cloud::Compute::V1::Operation

    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:

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

      Name of the NotificationEndpoint resource to delete.

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

      Project ID for this request.

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

      Name of the region scoping 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).

Yields:

  • (result, env) —

    Access the result along with the Faraday environment object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 177

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

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

  # 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 = {}

  # 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.timeout,
                         metadata:     call_metadata

  uri, _body, query_string_params = transcode_delete request
  response = @client_stub.make_delete_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
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::NotificationEndpoint #get(notification_endpoint: nil, project: nil, region: nil) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpoint

Returns the specified NotificationEndpoint resource in the given region.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetRegionNotificationEndpointRequest, ::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(notification_endpoint: nil, project: nil, region: nil) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpoint

    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:

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

      Name of the NotificationEndpoint resource to return.

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

      Project ID for this request.

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

      Name of the region scoping this request.

Yields:

  • (result, env) —

    Access the result along with the Faraday environment object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 245

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

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

  # 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 = {}

  # 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.timeout,
                         metadata:     call_metadata

  uri, _body, _query_string_params = transcode_get request
  response = @client_stub.make_get_request(
    uri:     uri,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::NotificationEndpoint.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
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) ⇒ ::Google::Cloud::Compute::V1::Operation #insert(notification_endpoint_resource: nil, project: nil, region: nil, request_id: nil) ⇒ ::Google::Cloud::Compute::V1::Operation

Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.

Overloads:

  • #insert(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::InsertRegionNotificationEndpointRequest, ::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(notification_endpoint_resource: nil, project: nil, region: nil, request_id: nil) ⇒ ::Google::Cloud::Compute::V1::Operation

    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:

    • notification_endpoint_resource (::Google::Cloud::Compute::V1::NotificationEndpoint, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Project ID for this request.

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

      Name of the region scoping 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).

Yields:

  • (result, env) —

    Access the result along with the Faraday environment object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



318
319
320
321
322
323
324
325
326
327
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
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 318

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

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

  # 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 = {}

  # 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.timeout,
                         metadata:     call_metadata

  uri, body, query_string_params = transcode_insert request
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
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) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpointList #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpointList

Lists the NotificationEndpoints for a project in the given region.

Overloads:

  • #list(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpointList

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::ListRegionNotificationEndpointsRequest, ::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, region: nil, return_partial_success: nil) ⇒ ::Google::Cloud::Compute::V1::NotificationEndpointList

    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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

      For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

      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.

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

      Name of the region 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 and the logic is the same as today.

Yields:

  • (result, env) —

    Access the result along with the Faraday environment object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/cloud/compute/v1/region_notification_endpoints/rest/client.rb', line 405

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

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

  # 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 = {}

  # 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.timeout,
                         metadata:     call_metadata

  uri, _body, query_string_params = transcode_list request
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::NotificationEndpointList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end