Class: Google::Cloud::Eventarc::V1::Eventarc::Client

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

Overview

Client for the Eventarc service.

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #service_account_path, #trigger_path

Constructor Details

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

Create a new Eventarc client object.

Examples:


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

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

Yields:

  • (config)

    Configure the Eventarc client.

Yield Parameters:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 110

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/eventarc/v1/eventarc_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 == Client.configure.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.endpoint = @config.endpoint
  end

  @eventarc_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Eventarc::V1::Eventarc::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client::Google::Cloud::Eventarc::V1::Eventarc::Operations (readonly)

Get the associated client for long-running operations.



156
157
158
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 156

def operations_client
  @operations_client
end

Class Method Details

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

Configure the Eventarc Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



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

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Eventarc", "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 Eventarc 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:



89
90
91
92
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 89

def configure
  yield @config if block_given?
  @config
end

#create_trigger(request, options = nil) ⇒ ::Gapic::Operation #create_trigger(parent: nil, trigger: nil, trigger_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new trigger in a particular project and location.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateTriggerRequest, ::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_trigger(parent: nil, trigger: nil, trigger_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_trigger 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 collection in which to add this trigger.

    • trigger (::Google::Cloud::Eventarc::V1::Trigger, ::Hash) (defaults to: nil)

      Required. The trigger to create.

    • trigger_id (::String) (defaults to: nil)

      Required. The user-provided ID to be assigned to the trigger.

    • validate_only (::Boolean) (defaults to: nil)

      Required. If set, validate the request and preview the review, but do not actually post it.

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.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 347

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Eventarc::V1::CreateTriggerRequest

  # 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
   = @config.rpcs.create_trigger..to_h

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

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

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

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

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

#delete_trigger(request, options = nil) ⇒ ::Gapic::Operation #delete_trigger(name: nil, etag: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Delete a single trigger.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::DeleteTriggerRequest, ::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_trigger(name: nil, etag: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_trigger 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 trigger to be deleted.

    • etag (::String) (defaults to: nil)

      If provided, the trigger will only be deleted if the etag matches the current etag on the resource.

    • allow_missing (::Boolean) (defaults to: nil)

      If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.

    • validate_only (::Boolean) (defaults to: nil)

      Required. If set, validate the request and preview the review, but do not actually post it.

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.



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
537
538
539
540
541
542
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 504

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Eventarc::V1::DeleteTriggerRequest

  # 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
   = @config.rpcs.delete_trigger..to_h

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

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

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

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

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

#get_trigger(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Trigger #get_trigger(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Trigger

Get a single trigger.

Overloads:

  • #get_trigger(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Trigger

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetTriggerRequest, ::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_trigger(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Trigger

    Pass arguments to get_trigger 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 trigger to get.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



189
190
191
192
193
194
195
196
197
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
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 189

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Eventarc::V1::GetTriggerRequest

  # 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
   = @config.rpcs.get_trigger..to_h

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

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

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

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

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

#list_triggers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger> #list_triggers(parent: nil, page_size: nil, page_token: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>

List triggers.

Overloads:

  • #list_triggers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListTriggersRequest, ::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_triggers(parent: nil, page_size: nil, page_token: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>

    Pass arguments to list_triggers 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 collection to list triggers on.

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

      The maximum number of triggers to return on each page. Note: The service may send fewer.

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

      The page token; provide the value from the next_page_token field in a previous ListTriggers call to retrieve the subsequent page.

      When paginating, all other parameters provided to ListTriggers must match the call that provided the page token.

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

      The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, trigger_id.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 271

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Eventarc::V1::ListTriggersRequest

  # 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
   = @config.rpcs.list_triggers..to_h

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

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

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

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

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

#update_trigger(request, options = nil) ⇒ ::Gapic::Operation #update_trigger(trigger: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single trigger.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::UpdateTriggerRequest, ::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_trigger(trigger: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    • trigger (::Google::Cloud::Eventarc::V1::Trigger, ::Hash) (defaults to: nil)

      The trigger to be updated.

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

      The fields to be updated; only fields explicitly provided will be updated. If no field mask is provided, all provided fields in the request will be updated. To update all fields, provide a field mask of "*".

    • allow_missing (::Boolean) (defaults to: nil)

      If set to true, and the trigger is not found, a new trigger will be created. In this situation, update_mask is ignored.

    • validate_only (::Boolean) (defaults to: nil)

      Required. If set, validate the request and preview the review, but do not actually post it.

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.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 426

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Eventarc::V1::UpdateTriggerRequest

  # 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
   = @config.rpcs.update_trigger..to_h

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

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

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

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

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