class Google::Cloud::Eventarc::V1::Eventarc::Client
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.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::Eventarc::V1::Eventarc::Operations]
Public Class Methods
Configure the Eventarc
Client
class.
See {::Google::Cloud::Eventarc::V1::Eventarc::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Eventarc clients ::Google::Cloud::Eventarc::V1::Eventarc::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# 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
Create a new Eventarc
client object.
@example
# 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
@yield [config] Configure the Eventarc
client. @yieldparam config [Client::Configuration]
# 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
Public Instance Methods
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 {Client.configure}.
See {::Google::Cloud::Eventarc::V1::Eventarc::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/eventarc/v1/eventarc/client.rb, line 89 def configure yield @config if block_given? @config end
Create a new trigger in a particular project and location.
@overload create_trigger
(request, options = nil)
Pass arguments to `create_trigger` via a request object, either of type {::Google::Cloud::Eventarc::V1::CreateTriggerRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_trigger
(parent: nil, trigger: nil, trigger_id: nil, validate_only: nil)
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). @param parent [::String] Required. The parent collection in which to add this trigger. @param trigger [::Google::Cloud::Eventarc::V1::Trigger, ::Hash] Required. The trigger to create. @param trigger_id [::String] Required. The user-provided ID to be assigned to the trigger. @param validate_only [::Boolean] Required. If set, validate the request and preview the review, but do not actually post it.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# 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 metadata = @config.rpcs.create_trigger.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Eventarc::V1::VERSION metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_trigger.timeout, metadata: metadata, retry_policy: @config.rpcs.create_trigger.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, 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 a single trigger.
@overload delete_trigger
(request, options = nil)
Pass arguments to `delete_trigger` via a request object, either of type {::Google::Cloud::Eventarc::V1::DeleteTriggerRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_trigger
(name: nil, etag: nil, allow_missing: nil, validate_only: nil)
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). @param name [::String] Required. The name of the trigger to be deleted. @param etag [::String] If provided, the trigger will only be deleted if the etag matches the current etag on the resource. @param allow_missing [::Boolean] If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server. @param validate_only [::Boolean] Required. If set, validate the request and preview the review, but do not actually post it.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# 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 metadata = @config.rpcs.delete_trigger.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Eventarc::V1::VERSION metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_trigger.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_trigger.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, 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 a single trigger.
@overload get_trigger
(request, options = nil)
Pass arguments to `get_trigger` via a request object, either of type {::Google::Cloud::Eventarc::V1::GetTriggerRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_trigger
(name: nil)
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). @param name [::String] Required. The name of the trigger to get.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Eventarc::V1::Trigger] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Eventarc::V1::Trigger]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# 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 metadata = @config.rpcs.get_trigger.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Eventarc::V1::VERSION metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_trigger.timeout, metadata: metadata, retry_policy: @config.rpcs.get_trigger.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, 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.
@overload list_triggers
(request, options = nil)
Pass arguments to `list_triggers` via a request object, either of type {::Google::Cloud::Eventarc::V1::ListTriggersRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_triggers
(parent: nil, page_size: nil, page_token: nil, order_by: nil)
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). @param parent [::String] Required. The parent collection to list triggers on. @param page_size [::Integer] The maximum number of triggers to return on each page. Note: The service may send fewer. @param page_token [::String] 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. @param order_by [::String] 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`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# 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 metadata = @config.rpcs.list_triggers.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Eventarc::V1::VERSION metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_triggers.timeout, metadata: metadata, retry_policy: @config.rpcs.list_triggers.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, 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 a single trigger.
@overload update_trigger
(request, options = nil)
Pass arguments to `update_trigger` via a request object, either of type {::Google::Cloud::Eventarc::V1::UpdateTriggerRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_trigger
(trigger: nil, update_mask: nil, allow_missing: nil, validate_only: nil)
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). @param trigger [::Google::Cloud::Eventarc::V1::Trigger, ::Hash] The trigger to be updated. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] 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 "*". @param allow_missing [::Boolean] If set to true, and the trigger is not found, a new trigger will be created. In this situation, `update_mask` is ignored. @param validate_only [::Boolean] Required. If set, validate the request and preview the review, but do not actually post it.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# 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 metadata = @config.rpcs.update_trigger.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Eventarc::V1::VERSION metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_trigger.timeout, metadata: metadata, retry_policy: @config.rpcs.update_trigger.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, 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