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

#channel_connection_path, #channel_path, #cloud_function_path, #crypto_key_path, #enrollment_path, #google_api_source_path, #google_channel_config_path, #location_path, #message_bus_path, #network_attachment_path, #pipeline_path, #provider_path, #service_account_path, #topic_path, #trigger_path, #workflow_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:



259
260
261
262
263
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 259

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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

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

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

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

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

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

Instance Attribute Details

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

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

Returns:

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


352
353
354
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 352

def iam_policy_client
  @iam_policy_client
end

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

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

Returns:

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


345
346
347
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 345

def location_client
  @location_client
end

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

Get the associated client for long-running operations.

Returns:



338
339
340
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 338

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:



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
101
102
103
104
105
106
107
108
109
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 65

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.rpcs.get_trigger.timeout = 60.0
    default_config.rpcs.get_trigger.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_triggers.timeout = 60.0
    default_config.rpcs.list_triggers.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_trigger.timeout = 60.0

    default_config.rpcs.update_trigger.timeout = 60.0

    default_config.rpcs.delete_trigger.timeout = 60.0

    default_config.rpcs.get_channel.timeout = 60.0
    default_config.rpcs.get_channel.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_channels.timeout = 60.0
    default_config.rpcs.list_channels.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_channel.timeout = 60.0

    default_config.rpcs.update_channel.timeout = 60.0

    default_config.rpcs.delete_channel.timeout = 60.0

    default_config.rpcs.get_provider.timeout = 60.0
    default_config.rpcs.get_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_providers.timeout = 60.0
    default_config.rpcs.list_providers.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.get_channel_connection.timeout = 60.0
    default_config.rpcs.get_channel_connection.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_channel_connections.timeout = 60.0
    default_config.rpcs.list_channel_connections.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_channel_connection.timeout = 60.0

    default_config.rpcs.delete_channel_connection.timeout = 60.0

    default_config.rpcs.get_google_channel_config.timeout = 60.0
    default_config.rpcs.get_google_channel_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.update_google_channel_config.timeout = 60.0

    default_config.rpcs.get_message_bus.timeout = 60.0
    default_config.rpcs.get_message_bus.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_message_buses.timeout = 60.0
    default_config.rpcs.list_message_buses.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_message_bus_enrollments.timeout = 60.0
    default_config.rpcs.list_message_bus_enrollments.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_message_bus.timeout = 60.0

    default_config.rpcs.update_message_bus.timeout = 60.0

    default_config.rpcs.delete_message_bus.timeout = 60.0

    default_config.rpcs.get_enrollment.timeout = 60.0
    default_config.rpcs.get_enrollment.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_enrollments.timeout = 60.0
    default_config.rpcs.list_enrollments.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_enrollment.timeout = 60.0

    default_config.rpcs.update_enrollment.timeout = 60.0

    default_config.rpcs.delete_enrollment.timeout = 60.0

    default_config.rpcs.get_pipeline.timeout = 60.0
    default_config.rpcs.get_pipeline.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_pipelines.timeout = 60.0
    default_config.rpcs.list_pipelines.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_pipeline.timeout = 60.0

    default_config.rpcs.update_pipeline.timeout = 60.0

    default_config.rpcs.delete_pipeline.timeout = 60.0

    default_config.rpcs.get_google_api_source.timeout = 60.0
    default_config.rpcs.get_google_api_source.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.list_google_api_sources.timeout = 60.0
    default_config.rpcs.list_google_api_sources.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_google_api_source.timeout = 60.0

    default_config.rpcs.update_google_api_source.timeout = 60.0

    default_config.rpcs.delete_google_api_source.timeout = 60.0

    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:



229
230
231
232
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 229

def configure
  yield @config if block_given?
  @config
end

#create_channel(request, options = nil) ⇒ ::Gapic::Operation #create_channel(parent: nil, channel: nil, channel_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new channel in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateChannelRequest.new

# Call the create_channel method.
result = client.create_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateChannelRequest, ::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_channel(parent: nil, channel: nil, channel_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    • channel (::Google::Cloud::Eventarc::V1::Channel, ::Hash) (defaults to: nil) —

      Required. The channel to create.

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1117

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

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

  # 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_channel.metadata.to_h

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

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

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

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

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

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

#create_channel_connection(request, options = nil) ⇒ ::Gapic::Operation #create_channel_connection(parent: nil, channel_connection: nil, channel_connection_id: nil) ⇒ ::Gapic::Operation

Create a new ChannelConnection in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateChannelConnectionRequest.new

# Call the create_channel_connection method.
result = client.create_channel_connection request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateChannelConnectionRequest, ::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_channel_connection(parent: nil, channel_connection: nil, channel_connection_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_channel_connection 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 channel connection.

    • channel_connection (::Google::Cloud::Eventarc::V1::ChannelConnection, ::Hash) (defaults to: nil) —

      Required. Channel connection to create.

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

      Required. The user-provided ID to be assigned to the channel connection.

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.



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1790

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

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

  # 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_channel_connection.metadata.to_h

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

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

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

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

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

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

#create_enrollment(request, options = nil) ⇒ ::Gapic::Operation #create_enrollment(parent: nil, enrollment: nil, enrollment_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new Enrollment in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateEnrollmentRequest.new

# Call the create_enrollment method.
result = client.create_enrollment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateEnrollmentRequest, ::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_enrollment(parent: nil, enrollment: nil, enrollment_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    • enrollment (::Google::Cloud::Eventarc::V1::Enrollment, ::Hash) (defaults to: nil) —

      Required. The enrollment to create.

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

      Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^a-z?$).

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

      Optional. If set, validate the request and preview the review, but do not 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.



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2952

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

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

  # 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_enrollment.metadata.to_h

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

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

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

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

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

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

#create_google_api_source(request, options = nil) ⇒ ::Gapic::Operation #create_google_api_source(parent: nil, google_api_source: nil, google_api_source_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new GoogleApiSource in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateGoogleApiSourceRequest.new

# Call the create_google_api_source method.
result = client.create_google_api_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateGoogleApiSourceRequest, ::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_google_api_source(parent: nil, google_api_source: nil, google_api_source_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_google_api_source 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 google api source.

    • google_api_source (::Google::Cloud::Eventarc::V1::GoogleApiSource, ::Hash) (defaults to: nil) —

      Required. The google api source to create.

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

      Required. The user-provided ID to be assigned to the GoogleApiSource. It should match the format (^a-z?$).

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

      Optional. If set, validate the request and preview the review, but do not 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.



3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3957

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

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

  # 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_google_api_source.metadata.to_h

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

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

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

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

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

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

#create_message_bus(request, options = nil) ⇒ ::Gapic::Operation #create_message_bus(parent: nil, message_bus: nil, message_bus_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new MessageBus in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateMessageBusRequest.new

# Call the create_message_bus method.
result = client.create_message_bus request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreateMessageBusRequest, ::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_message_bus(parent: nil, message_bus: nil, message_bus_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_message_bus 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 message bus.

    • message_bus (::Google::Cloud::Eventarc::V1::MessageBus, ::Hash) (defaults to: nil) —

      Required. The message bus to create.

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

      Required. The user-provided ID to be assigned to the MessageBus. It should match the format (^a-z?$)

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

      Optional. If set, validate the request and preview the review, but do not 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.



2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2449

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

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

  # 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_message_bus.metadata.to_h

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

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

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

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

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

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

#create_pipeline(request, options = nil) ⇒ ::Gapic::Operation #create_pipeline(parent: nil, pipeline: nil, pipeline_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Create a new Pipeline in a particular project and location.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreatePipelineRequest.new

# Call the create_pipeline method.
result = client.create_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::CreatePipelineRequest, ::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_pipeline(parent: nil, pipeline: nil, pipeline_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    • pipeline (::Google::Cloud::Eventarc::V1::Pipeline, ::Hash) (defaults to: nil) —

      Required. The pipeline to create.

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3454

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

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

  # 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_pipeline.metadata.to_h

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

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

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

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

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

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

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

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::CreateTriggerRequest.new

# Call the create_trigger method.
result = client.create_trigger request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_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) —

      Optional. If set, validate the request and preview the review, but do not 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.



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 618

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  options.apply_defaults timeout:      @config.rpcs.create_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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_channel(request, options = nil) ⇒ ::Gapic::Operation #delete_channel(name: nil, validate_only: nil) ⇒ ::Gapic::Operation

Delete a single channel.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteChannelRequest.new

# Call the delete_channel method.
result = client.delete_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_channel 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 channel to be deleted.

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

      Optional. If set, validate the request and preview the review, but do not 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.



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1315

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

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

  # 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_channel.metadata.to_h

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

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

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

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

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

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

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

Delete a single ChannelConnection.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteChannelConnectionRequest.new

# Call the delete_channel_connection method.
result = client.delete_channel_connection request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::DeleteChannelConnectionRequest, ::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_channel_connection(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_channel_connection 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 channel connection to delete.

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.



1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1884

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

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

  # 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_channel_connection.metadata.to_h

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

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

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

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

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

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

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

Delete a single Enrollment.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteEnrollmentRequest.new

# Call the delete_enrollment method.
result = client.delete_enrollment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_enrollment 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 Enrollment to be deleted.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3159

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

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

  # 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_enrollment.metadata.to_h

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

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

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

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

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

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

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

Delete a single GoogleApiSource.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteGoogleApiSourceRequest.new

# Call the delete_google_api_source method.
result = client.delete_google_api_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_google_api_source 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 GoogleApiSource to be deleted.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 4165

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

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

  # 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_google_api_source.metadata.to_h

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

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

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

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

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

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

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

Delete a single message bus.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteMessageBusRequest.new

# Call the delete_message_bus method.
result = client.delete_message_bus request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_message_bus 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 MessageBus to be deleted.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2656

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

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

  # 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_message_bus.metadata.to_h

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

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

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

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

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

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

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

Delete a single pipeline.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeletePipelineRequest.new

# Call the delete_pipeline method.
result = client.delete_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_pipeline 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 Pipeline to be deleted.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3661

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

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

  # 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_pipeline.metadata.to_h

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

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

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

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

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

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

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

Delete a single trigger.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::DeleteTriggerRequest.new

# Call the delete_trigger method.
result = client.delete_trigger request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_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) —

      Optional. If set, validate the request and preview the review, but do not 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.



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

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_channel(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Channel #get_channel(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Channel

Get a single Channel.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetChannelRequest.new

# Call the get_channel method.
result = client.get_channel request

# The returned object is of type Google::Cloud::Eventarc::V1::Channel.
p result

Overloads:

  • #get_channel(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Channel

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetChannelRequest, ::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_channel(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Channel

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



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

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

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

  # 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_channel.metadata.to_h

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

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

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

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

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

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

#get_channel_connection(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::ChannelConnection #get_channel_connection(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::ChannelConnection

Get a single ChannelConnection.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetChannelConnectionRequest.new

# Call the get_channel_connection method.
result = client.get_channel_connection request

# The returned object is of type Google::Cloud::Eventarc::V1::ChannelConnection.
p result

Overloads:

  • #get_channel_connection(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::ChannelConnection

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetChannelConnectionRequest, ::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_channel_connection(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::ChannelConnection

    Pass arguments to get_channel_connection 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 channel connection 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.



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1593

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

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

  # 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_channel_connection.metadata.to_h

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

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

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

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

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

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

#get_enrollment(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Enrollment #get_enrollment(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Enrollment

Get a single Enrollment.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetEnrollmentRequest.new

# Call the get_enrollment method.
result = client.get_enrollment request

# The returned object is of type Google::Cloud::Eventarc::V1::Enrollment.
p result

Overloads:

  • #get_enrollment(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Enrollment

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetEnrollmentRequest, ::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_enrollment(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Enrollment

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



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2743

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

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

  # 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_enrollment.metadata.to_h

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

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

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

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

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

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

#get_google_api_source(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleApiSource #get_google_api_source(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleApiSource

Get a single GoogleApiSource.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetGoogleApiSourceRequest.new

# Call the get_google_api_source method.
result = client.get_google_api_source request

# The returned object is of type Google::Cloud::Eventarc::V1::GoogleApiSource.
p result

Overloads:

  • #get_google_api_source(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleApiSource

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetGoogleApiSourceRequest, ::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_google_api_source(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleApiSource

    Pass arguments to get_google_api_source 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 google api source 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.



3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3748

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

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

  # 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_google_api_source.metadata.to_h

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

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

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

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

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

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

#get_google_channel_config(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig #get_google_channel_config(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

Get a GoogleChannelConfig

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetGoogleChannelConfigRequest.new

# Call the get_google_channel_config method.
result = client.get_google_channel_config request

# The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
p result

Overloads:

  • #get_google_channel_config(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetGoogleChannelConfigRequest, ::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_google_channel_config(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

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



1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1971

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

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

  # 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_google_channel_config.metadata.to_h

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

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

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

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

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

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

#get_message_bus(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::MessageBus #get_message_bus(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::MessageBus

Get a single MessageBus.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetMessageBusRequest.new

# Call the get_message_bus method.
result = client.get_message_bus request

# The returned object is of type Google::Cloud::Eventarc::V1::MessageBus.
p result

Overloads:

  • #get_message_bus(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::MessageBus

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetMessageBusRequest, ::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_message_bus(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::MessageBus

    Pass arguments to get_message_bus 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 message bus 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.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2145

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

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

  # 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_message_bus.metadata.to_h

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

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

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

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

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

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

#get_pipeline(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Pipeline #get_pipeline(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Pipeline

Get a single Pipeline.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetPipelineRequest.new

# Call the get_pipeline method.
result = client.get_pipeline request

# The returned object is of type Google::Cloud::Eventarc::V1::Pipeline.
p result

Overloads:

  • #get_pipeline(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Pipeline

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetPipelineRequest, ::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_pipeline(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Pipeline

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



3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3246

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

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

  # 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_pipeline.metadata.to_h

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

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

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

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

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

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

#get_provider(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Provider #get_provider(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Provider

Get a single Provider.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetProviderRequest.new

# Call the get_provider method.
result = client.get_provider request

# The returned object is of type Google::Cloud::Eventarc::V1::Provider.
p result

Overloads:

  • #get_provider(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::Provider

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::GetProviderRequest, ::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_provider(name: nil) ⇒ ::Google::Cloud::Eventarc::V1::Provider

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



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1402

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

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

  # 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_provider.metadata.to_h

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

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

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

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

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

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

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

Get a single trigger.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::GetTriggerRequest.new

# Call the get_trigger method.
result = client.get_trigger request

# The returned object is of type Google::Cloud::Eventarc::V1::Trigger.
p result

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.



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
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 409

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  options.apply_defaults timeout:      @config.rpcs.get_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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

List channel connections.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListChannelConnectionsRequest.new

# Call the list_channel_connections method.
result = client.list_channel_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::ChannelConnection.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListChannelConnectionsRequest, ::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_channel_connections(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::ChannelConnection>

    Pass arguments to list_channel_connections 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 from which to list channel connections.

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

      The maximum number of channel connections to return on each page.

      Note: The service may send fewer responses.

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1692

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

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

  # 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_channel_connections.metadata.to_h

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

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

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

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

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

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

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

List channels.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListChannelsRequest.new

# Call the list_channels method.
result = client.list_channels request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::Channel.
  p item
end

Overloads:

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

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

    Parameters:

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

    Pass arguments to list_channels 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 channels on.

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

      The maximum number of channels 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 ListChannels call to retrieve the subsequent page.

      When paginating, all other parameters provided to ListChannels 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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_id.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1016

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

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

  # 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_channels.metadata.to_h

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

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

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

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

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

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

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

List Enrollments.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListEnrollmentsRequest.new

# Call the list_enrollments method.
result = client.list_enrollments request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::Enrollment.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListEnrollmentsRequest, ::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_enrollments(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Enrollment>

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

      Optional. The maximum number of results to return on each page.

      Note: The service may send fewer.

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

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

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

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

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

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

      Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2850

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

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

  # 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_enrollments.metadata.to_h

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

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

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

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

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

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

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

List GoogleApiSources.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListGoogleApiSourcesRequest.new

# Call the list_google_api_sources method.
result = client.list_google_api_sources request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::GoogleApiSource.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListGoogleApiSourcesRequest, ::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_google_api_sources(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::GoogleApiSource>

    Pass arguments to list_google_api_sources 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 GoogleApiSources on.

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

      Optional. The maximum number of results to return on each page.

      Note: The service may send fewer.

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

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

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

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

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

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

      Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3855

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

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

  # 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_google_api_sources.metadata.to_h

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

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

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

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

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

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

#list_message_bus_enrollments(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsResponse #list_message_bus_enrollments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsResponse

List message bus enrollments.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsRequest.new

# Call the list_message_bus_enrollments method.
result = client.list_message_bus_enrollments request

# The returned object is of type Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsResponse.
p result

Overloads:

  • #list_message_bus_enrollments(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsResponse

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsRequest, ::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_message_bus_enrollments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Eventarc::V1::ListMessageBusEnrollmentsResponse

    Pass arguments to list_message_bus_enrollments 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 message bus to list enrollments on.

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

      Optional. The maximum number of results to return on each page.

      Note: The service may send fewer.

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

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2349

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

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

  # 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_message_bus_enrollments.metadata.to_h

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

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

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

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

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

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

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

List message buses.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListMessageBusesRequest.new

# Call the list_message_buses method.
result = client.list_message_buses request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::MessageBus.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListMessageBusesRequest, ::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_message_buses(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::MessageBus>

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

      Optional. The maximum number of results to return on each page.

      Note: The service may send fewer.

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

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

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

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

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

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

      Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2252

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

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

  # 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_message_buses.metadata.to_h

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

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

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

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

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

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

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

List pipelines.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListPipelinesRequest.new

# Call the list_pipelines method.
result = client.list_pipelines request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::Pipeline.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListPipelinesRequest, ::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_pipelines(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Pipeline>

    Pass arguments to list_pipelines 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 pipelines on.

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

      Optional. The maximum number of results to return on each page.

      Note: The service may send fewer.

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

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

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

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

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

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

      Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3353

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

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

  # 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_pipelines.metadata.to_h

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

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

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

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

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

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

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

List providers.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListProvidersRequest.new

# Call the list_providers method.
result = client.list_providers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::Provider.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::ListProvidersRequest, ::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_providers(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Provider>

    Pass arguments to list_providers 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 of the provider to get.

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

      The maximum number of providers to return on each page.

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

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

      When paginating, all other parameters provided to ListProviders 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, _id.

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

      The filter field that the list request will filter on.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1506

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

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

  # 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_providers.metadata.to_h

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

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

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

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

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

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

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

List triggers.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::ListTriggersRequest.new

# Call the list_triggers method.
result = client.list_triggers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Eventarc::V1::Trigger.
  p item
end

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, filter: 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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, trigger_id.

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

      Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 517

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  options.apply_defaults timeout:      @config.rpcs.list_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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


359
360
361
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 359

def logger
  @eventarc_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


239
240
241
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 239

def universe_domain
  @eventarc_stub.universe_domain
end

#update_channel(request, options = nil) ⇒ ::Gapic::Operation #update_channel(channel: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single channel.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateChannelRequest.new

# Call the update_channel method.
result = client.update_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::UpdateChannelRequest, ::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_channel(channel: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

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

    • channel (::Google::Cloud::Eventarc::V1::Channel, ::Hash) (defaults to: nil) —

      The channel to be updated.

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 1218

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

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

  # 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_channel.metadata.to_h

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

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

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

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

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

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

#update_enrollment(request, options = nil) ⇒ ::Gapic::Operation #update_enrollment(enrollment: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single Enrollment.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateEnrollmentRequest.new

# Call the update_enrollment method.
result = client.update_enrollment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

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

    • enrollment (::Google::Cloud::Eventarc::V1::Enrollment, ::Hash) (defaults to: nil) —

      Required. The Enrollment to be updated.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3056

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

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

  # 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_enrollment.metadata.to_h

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

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

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

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

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

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

#update_google_api_source(request, options = nil) ⇒ ::Gapic::Operation #update_google_api_source(google_api_source: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single GoogleApiSource.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateGoogleApiSourceRequest.new

# Call the update_google_api_source method.
result = client.update_google_api_source request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

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

    • google_api_source (::Google::Cloud::Eventarc::V1::GoogleApiSource, ::Hash) (defaults to: nil) —

      Required. The GoogleApiSource to be updated.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 4062

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

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

  # 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_google_api_source.metadata.to_h

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

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

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

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

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

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

#update_google_channel_config(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig #update_google_channel_config(google_channel_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

Update a single GoogleChannelConfig

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateGoogleChannelConfigRequest.new

# Call the update_google_channel_config method.
result = client.update_google_channel_config request

# The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
p result

Overloads:

  • #update_google_channel_config(request, options = nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

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

    Parameters:

    • request (::Google::Cloud::Eventarc::V1::UpdateGoogleChannelConfigRequest, ::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_google_channel_config(google_channel_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

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

    • google_channel_config (::Google::Cloud::Eventarc::V1::GoogleChannelConfig, ::Hash) (defaults to: nil) —

      Required. The config to be updated.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2060

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

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

  # 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_google_channel_config.metadata.to_h

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

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

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

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

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

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

#update_message_bus(request, options = nil) ⇒ ::Gapic::Operation #update_message_bus(message_bus: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single message bus.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateMessageBusRequest.new

# Call the update_message_bus method.
result = client.update_message_bus request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

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

    • message_bus (::Google::Cloud::Eventarc::V1::MessageBus, ::Hash) (defaults to: nil) —

      Required. The MessageBus to be updated.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 2553

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

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

  # 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_message_bus.metadata.to_h

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

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

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

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

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

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

#update_pipeline(request, options = nil) ⇒ ::Gapic::Operation #update_pipeline(pipeline: nil, update_mask: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Update a single pipeline.

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdatePipelineRequest.new

# Call the update_pipeline method.
result = client.update_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

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

    Parameters:

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

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

    • pipeline (::Google::Cloud::Eventarc::V1::Pipeline, ::Hash) (defaults to: nil) —

      Required. The Pipeline to be updated.

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

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

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

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

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

      Optional. If set, validate the request and preview the review, but do not 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.



3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
 
# File 'lib/google/cloud/eventarc/v1/eventarc/client.rb', line 3558

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

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

  # 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_pipeline.metadata.to_h

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

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

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

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

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

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

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

Examples:

Basic example

require "google/cloud/eventarc/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Eventarc::V1::Eventarc::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Eventarc::V1::UpdateTriggerRequest.new

# Call the update_trigger method.
result = client.update_trigger request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_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 are updated. If no field mask is provided, all provided fields in the request are 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) —

      Optional. If set, validate the request and preview the review, but do not 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.



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

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Eventarc::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  options.apply_defaults timeout:      @config.rpcs.update_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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end