Eventarc - Documentation

Constructor

new Eventarc(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Eventarc service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createChannel(request, callback) → {undefined}

Calls CreateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateChannelRequest	CreateChannelRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.CreateChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createChannel(request) → {Promise.<google.longrunning.Operation>}

Calls CreateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateChannelRequest	CreateChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createChannelConnection(request, callback) → {undefined}

Calls CreateChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateChannelConnectionRequest	CreateChannelConnectionRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.CreateChannelConnectionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createChannelConnection(request) → {Promise.<google.longrunning.Operation>}

Calls CreateChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateChannelConnectionRequest	CreateChannelConnectionRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createTrigger(request, callback) → {undefined}

Calls CreateTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateTriggerRequest	CreateTriggerRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.CreateTriggerCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createTrigger(request) → {Promise.<google.longrunning.Operation>}

Calls CreateTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.ICreateTriggerRequest	CreateTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteChannel(request, callback) → {undefined}

Calls DeleteChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteChannelRequest	DeleteChannelRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.DeleteChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteChannel(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteChannelRequest	DeleteChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteChannelConnection(request, callback) → {undefined}

Calls DeleteChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteChannelConnectionRequest	DeleteChannelConnectionRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.DeleteChannelConnectionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteChannelConnection(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteChannelConnectionRequest	DeleteChannelConnectionRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteTrigger(request, callback) → {undefined}

Calls DeleteTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteTriggerRequest	DeleteTriggerRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.DeleteTriggerCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteTrigger(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IDeleteTriggerRequest	DeleteTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getChannel(request, callback) → {undefined}

Calls GetChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetChannelRequest	GetChannelRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.GetChannelCallback	Node-style callback called with the error, if any, and Channel

Returns:

Type	Description
undefined

getChannel(request) → {Promise.<google.cloud.eventarc.v1.Channel>}

Calls GetChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetChannelRequest	GetChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.Channel>	Promise

getChannelConnection(request, callback) → {undefined}

Calls GetChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetChannelConnectionRequest	GetChannelConnectionRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.GetChannelConnectionCallback	Node-style callback called with the error, if any, and ChannelConnection

Returns:

Type	Description
undefined

getChannelConnection(request) → {Promise.<google.cloud.eventarc.v1.ChannelConnection>}

Calls GetChannelConnection.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetChannelConnectionRequest	GetChannelConnectionRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.ChannelConnection>	Promise

getGoogleChannelConfig(request, callback) → {undefined}

Calls GetGoogleChannelConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest	GetGoogleChannelConfigRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.GetGoogleChannelConfigCallback	Node-style callback called with the error, if any, and GoogleChannelConfig

Returns:

Type	Description
undefined

getGoogleChannelConfig(request) → {Promise.<google.cloud.eventarc.v1.GoogleChannelConfig>}

Calls GetGoogleChannelConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest	GetGoogleChannelConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.GoogleChannelConfig>	Promise

getProvider(request, callback) → {undefined}

Calls GetProvider.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetProviderRequest	GetProviderRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.GetProviderCallback	Node-style callback called with the error, if any, and Provider

Returns:

Type	Description
undefined

getProvider(request) → {Promise.<google.cloud.eventarc.v1.Provider>}

Calls GetProvider.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetProviderRequest	GetProviderRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.Provider>	Promise

getTrigger(request, callback) → {undefined}

Calls GetTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetTriggerRequest	GetTriggerRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.GetTriggerCallback	Node-style callback called with the error, if any, and Trigger

Returns:

Type	Description
undefined

getTrigger(request) → {Promise.<google.cloud.eventarc.v1.Trigger>}

Calls GetTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IGetTriggerRequest	GetTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.Trigger>	Promise

listChannelConnections(request, callback) → {undefined}

Calls ListChannelConnections.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListChannelConnectionsRequest	ListChannelConnectionsRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.ListChannelConnectionsCallback	Node-style callback called with the error, if any, and ListChannelConnectionsResponse

Returns:

Type	Description
undefined

listChannelConnections(request) → {Promise.<google.cloud.eventarc.v1.ListChannelConnectionsResponse>}

Calls ListChannelConnections.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListChannelConnectionsRequest	ListChannelConnectionsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.ListChannelConnectionsResponse>	Promise

listChannels(request, callback) → {undefined}

Calls ListChannels.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListChannelsRequest	ListChannelsRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.ListChannelsCallback	Node-style callback called with the error, if any, and ListChannelsResponse

Returns:

Type	Description
undefined

listChannels(request) → {Promise.<google.cloud.eventarc.v1.ListChannelsResponse>}

Calls ListChannels.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListChannelsRequest	ListChannelsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.ListChannelsResponse>	Promise

listProviders(request, callback) → {undefined}

Calls ListProviders.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListProvidersRequest	ListProvidersRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.ListProvidersCallback	Node-style callback called with the error, if any, and ListProvidersResponse

Returns:

Type	Description
undefined

listProviders(request) → {Promise.<google.cloud.eventarc.v1.ListProvidersResponse>}

Calls ListProviders.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListProvidersRequest	ListProvidersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.ListProvidersResponse>	Promise

listTriggers(request, callback) → {undefined}

Calls ListTriggers.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListTriggersRequest	ListTriggersRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.ListTriggersCallback	Node-style callback called with the error, if any, and ListTriggersResponse

Returns:

Type	Description
undefined

listTriggers(request) → {Promise.<google.cloud.eventarc.v1.ListTriggersResponse>}

Calls ListTriggers.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IListTriggersRequest	ListTriggersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.ListTriggersResponse>	Promise

updateChannel(request, callback) → {undefined}

Calls UpdateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateChannelRequest	UpdateChannelRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.UpdateChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateChannel(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateChannelRequest	UpdateChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateGoogleChannelConfig(request, callback) → {undefined}

Calls UpdateGoogleChannelConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest	UpdateGoogleChannelConfigRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.UpdateGoogleChannelConfigCallback	Node-style callback called with the error, if any, and GoogleChannelConfig

Returns:

Type	Description
undefined

updateGoogleChannelConfig(request) → {Promise.<google.cloud.eventarc.v1.GoogleChannelConfig>}

Calls UpdateGoogleChannelConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest	UpdateGoogleChannelConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.eventarc.v1.GoogleChannelConfig>	Promise

updateTrigger(request, callback) → {undefined}

Calls UpdateTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateTriggerRequest	UpdateTriggerRequest message or plain object
`callback`	google.cloud.eventarc.v1.Eventarc.UpdateTriggerCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateTrigger(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateTrigger.

Parameters:

Name	Type	Description
`request`	google.cloud.eventarc.v1.IUpdateTriggerRequest	UpdateTriggerRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Eventarc}

Creates new Eventarc service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
Eventarc	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateChannelCallback(error, responseopt)

Callback as used by createChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateChannelConnectionCallback(error, responseopt)

Callback as used by createChannelConnection.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateTriggerCallback(error, responseopt)

Callback as used by createTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteChannelCallback(error, responseopt)

Callback as used by deleteChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteChannelConnectionCallback(error, responseopt)

Callback as used by deleteChannelConnection.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteTriggerCallback(error, responseopt)

Callback as used by deleteTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetChannelCallback(error, responseopt)

Callback as used by getChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.Channel	<optional>	Channel

GetChannelConnectionCallback(error, responseopt)

Callback as used by getChannelConnection.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.ChannelConnection	<optional>	ChannelConnection

GetGoogleChannelConfigCallback(error, responseopt)

Callback as used by getGoogleChannelConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.GoogleChannelConfig	<optional>	GoogleChannelConfig

GetProviderCallback(error, responseopt)

Callback as used by getProvider.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.Provider	<optional>	Provider

GetTriggerCallback(error, responseopt)

Callback as used by getTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.Trigger	<optional>	Trigger

ListChannelConnectionsCallback(error, responseopt)

Callback as used by listChannelConnections.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.ListChannelConnectionsResponse	<optional>	ListChannelConnectionsResponse

ListChannelsCallback(error, responseopt)

Callback as used by listChannels.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.ListChannelsResponse	<optional>	ListChannelsResponse

ListProvidersCallback(error, responseopt)

Callback as used by listProviders.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.ListProvidersResponse	<optional>	ListProvidersResponse

ListTriggersCallback(error, responseopt)

Callback as used by listTriggers.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.ListTriggersResponse	<optional>	ListTriggersResponse

UpdateChannelCallback(error, responseopt)

Callback as used by updateChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateGoogleChannelConfigCallback(error, responseopt)

Callback as used by updateGoogleChannelConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.eventarc.v1.GoogleChannelConfig	<optional>	GoogleChannelConfig

UpdateTriggerCallback(error, responseopt)

Callback as used by updateTrigger.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation