Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Eventarc::Client (v1.0.0)

Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Eventarc::Client.

Client for the Eventarc service.

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

Inherits

Object

Includes

Google::Cloud::Eventarc::V1::Eventarc::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Eventarc Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_channel

def create_channel(request, options = nil) -> ::Gapic::Operation
def create_channel(parent: nil, channel: nil, channel_id: nil, validate_only: nil) -> ::Gapic::Operation

Create a new channel in a particular project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection in which to add this channel.
channel (::Google::Cloud::Eventarc::V1::Channel, ::Hash) — Required. The channel to create.
channel_id (::String) — Required. The user-provided ID to be assigned to the channel.
validate_only (::Boolean) — Required. 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.

Example

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

#create_channel_connection

def create_channel_connection(request, options = nil) -> ::Gapic::Operation
def create_channel_connection(parent: nil, channel_connection: nil, channel_connection_id: nil) -> ::Gapic::Operation

Create a new ChannelConnection in a particular project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection in which to add this channel connection.
channel_connection (::Google::Cloud::Eventarc::V1::ChannelConnection, ::Hash) — Required. Channel connection to create.
channel_connection_id (::String) — 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.

Example

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

#create_trigger

def create_trigger(request, options = nil) -> ::Gapic::Operation
def create_trigger(parent: nil, trigger: nil, trigger_id: nil, validate_only: nil) -> ::Gapic::Operation

Create a new trigger in a particular project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection in which to add this trigger.
trigger (::Google::Cloud::Eventarc::V1::Trigger, ::Hash) — Required. The trigger to create.
trigger_id (::String) — Required. The user-provided ID to be assigned to the trigger.
validate_only (::Boolean) — Required. 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.

Example

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

#delete_channel

def delete_channel(request, options = nil) -> ::Gapic::Operation
def delete_channel(name: nil, validate_only: nil) -> ::Gapic::Operation

Delete a single channel.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the channel to be deleted.
validate_only (::Boolean) — Required. 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.

Example

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

#delete_channel_connection

def delete_channel_connection(request, options = nil) -> ::Gapic::Operation
def delete_channel_connection(name: nil) -> ::Gapic::Operation

Delete a single ChannelConnection.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — 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.

Example

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

#delete_trigger

def delete_trigger(request, options = nil) -> ::Gapic::Operation
def delete_trigger(name: nil, etag: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation

Delete a single trigger.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The name of the trigger to be deleted.
etag (::String) — If provided, the trigger will only be deleted if the etag matches the current etag on the resource.
allow_missing (::Boolean) — If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.
validate_only (::Boolean) — Required. 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.

Example

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

#get_channel

def get_channel(request, options = nil) -> ::Google::Cloud::Eventarc::V1::Channel
def get_channel(name: nil) -> ::Google::Cloud::Eventarc::V1::Channel

Get a single Channel.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the channel to get.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Eventarc::V1::Channel)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::Channel)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#get_channel_connection

def get_channel_connection(request, options = nil) -> ::Google::Cloud::Eventarc::V1::ChannelConnection
def get_channel_connection(name: nil) -> ::Google::Cloud::Eventarc::V1::ChannelConnection

Get a single ChannelConnection.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the channel connection to get.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Eventarc::V1::ChannelConnection)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::ChannelConnection)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#get_google_channel_config

def get_google_channel_config(request, options = nil) -> ::Google::Cloud::Eventarc::V1::GoogleChannelConfig
def get_google_channel_config(name: nil) -> ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

Get a GoogleChannelConfig

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the config to get.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Eventarc::V1::GoogleChannelConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::GoogleChannelConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#get_provider

def get_provider(request, options = nil) -> ::Google::Cloud::Eventarc::V1::Provider
def get_provider(name: nil) -> ::Google::Cloud::Eventarc::V1::Provider

Get a single Provider.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the provider to get.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Eventarc::V1::Provider)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::Provider)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#get_trigger

def get_trigger(request, options = nil) -> ::Google::Cloud::Eventarc::V1::Trigger
def get_trigger(name: nil) -> ::Google::Cloud::Eventarc::V1::Trigger

Get a single trigger.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the trigger to get.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Eventarc::V1::Trigger)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::Trigger)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

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

Returns

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

#initialize

def initialize() { |config| ... } -> Client

Create a new Eventarc client object.

Yields

(config) — Configure the Eventarc client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#list_channel_connections

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

List channel connections.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection from which to list channel connections.
page_size (::Integer) — The maximum number of channel connections to return on each page.

Note: The service may send fewer responses.
page_token (::String) — 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

response (::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::ChannelConnection>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::ChannelConnection>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#list_channels

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

List channels.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection to list channels on.
page_size (::Integer) — The maximum number of channels to return on each page.

Note: The service may send fewer.
page_token (::String) — 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) — 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

response (::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Channel>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Channel>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#list_providers

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

List providers.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent of the provider to get.
page_size (::Integer) — The maximum number of providers to return on each page.
page_token (::String) — 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) — 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) — The filter field that the list request will filter on.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Provider>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Provider>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#list_triggers

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

List triggers.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The parent collection to list triggers on.
page_size (::Integer) — The maximum number of triggers to return on each page.

Note: The service may send fewer.
page_token (::String) — The page token; provide the value from the next_page_token field in a previous ListTriggers call to retrieve the subsequent page.

When paginating, all other parameters provided to ListTriggers must match the call that provided the page token.
order_by (::String) — 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) — 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

response (::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Eventarc::V1::Trigger>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

Returns

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

#operations_client

def operations_client() -> ::Google::Cloud::Eventarc::V1::Eventarc::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Eventarc::V1::Eventarc::Operations)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_channel

def update_channel(request, options = nil) -> ::Gapic::Operation
def update_channel(channel: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Update a single channel.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — The channel to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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) — Required. 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.

Example

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

#update_google_channel_config

def update_google_channel_config(request, options = nil) -> ::Google::Cloud::Eventarc::V1::GoogleChannelConfig
def update_google_channel_config(google_channel_config: nil, update_mask: nil) -> ::Google::Cloud::Eventarc::V1::GoogleChannelConfig

Update a single GoogleChannelConfig

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The config to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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

response (::Google::Cloud::Eventarc::V1::GoogleChannelConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Eventarc::V1::GoogleChannelConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

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

#update_trigger

def update_trigger(request, options = nil) -> ::Gapic::Operation
def update_trigger(trigger: nil, update_mask: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation

Update a single trigger.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — The trigger to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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) — 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) — Required. 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.

Example

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