Class v1.EventarcClient (4.0.1) Stay organized with collections Save and categorize content based on your preferences.
Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations. v1
Package
@google-cloud/eventarcConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of EventarcClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeofgax | typeoffallback: loaded instance of |
Properties
apiEndpoint
getapiEndpoint():string;The DNS address for this API service.
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;eventarcStub
eventarcStub?:Promise<{[name:string]:Function;}>;iamClient
iamClient:IamClient;innerApiCalls
innerApiCalls:{[name:string]:Function;};locationsClient
locationsClient:LocationsClient;operationsClient
operationsClient:gax.OperationsClient;pathTemplates
pathTemplates:{[name:string]:gax.PathTemplate;};port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
universeDomain
getuniverseDomain():string;warn
warn:(code:string,message:string,warnType?:string)=>void;Methods
cancelOperation(request, optionsOrCallback, callback)
cancelOperation(request:protos.google.longrunning.CancelOperationRequest,optionsOrCallback?:gax.CallOptions|Callback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty,{}|undefined|null>,callback?:Callback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty,{}|undefined|null>):Promise<protos.google.protobuf.Empty>;Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding toCode.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request | CancelOperationRequestThe request object that will be sent. |
optionsOrCallback | CallOptions |Callback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty, {} | undefined | null> |
callback | Callback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty, {} | undefined | null>The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> | |
constclient=longrunning.operationsClient();awaitclient.cancelOperation({name:''});channelConnectionPath(project, location, channelConnection)
channelConnectionPath(project:string,location:string,channelConnection:string):string;Return a fully-qualified channelConnection resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
channelConnection | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
channelPath(project, location, channel)
channelPath(project:string,location:string,channel:string):string;Return a fully-qualified channel resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
channel | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
checkCreateChannelConnectionProgress(name)
checkCreateChannelConnectionProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.ChannelConnection,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateChannelConnection().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.ChannelConnection,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this channel connection. */// const parent = 'abc123'/** * Required. Channel connection to create. */// const channelConnection = {}/** * Required. The user-provided ID to be assigned to the channel connection. */// const channelConnectionId = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateChannelConnection(){// Construct requestconstrequest={parent,channelConnection,channelConnectionId,};// Run requestconst[operation]=awaiteventarcClient.createChannelConnection(request);const[response]=awaitoperation.promise();console.log(response);}callCreateChannelConnection();checkCreateChannelProgress(name)
checkCreateChannelProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateChannel().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this channel. */// const parent = 'abc123'/** * Required. The channel to create. */// const channel = {}/** * Required. The user-provided ID to be assigned to the channel. */// const channelId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateChannel(){// Construct requestconstrequest={parent,channel,channelId,};// Run requestconst[operation]=awaiteventarcClient.createChannel(request);const[response]=awaitoperation.promise();console.log(response);}callCreateChannel();checkCreateEnrollmentProgress(name)
checkCreateEnrollmentProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateEnrollment().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this enrollment. */// const parent = 'abc123'/** * Required. The enrollment to create. */// const enrollment = {}/** * Required. The user-provided ID to be assigned to the Enrollment. It should * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). */// const enrollmentId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateEnrollment(){// Construct requestconstrequest={parent,enrollment,enrollmentId,};// Run requestconst[operation]=awaiteventarcClient.createEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callCreateEnrollment();checkCreateGoogleApiSourceProgress(name)
checkCreateGoogleApiSourceProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateGoogleApiSource().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this google api source. */// const parent = 'abc123'/** * Required. The google api source to create. */// const googleApiSource = {}/** * Required. The user-provided ID to be assigned to the GoogleApiSource. It * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). */// const googleApiSourceId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateGoogleApiSource(){// Construct requestconstrequest={parent,googleApiSource,googleApiSourceId,};// Run requestconst[operation]=awaiteventarcClient.createGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callCreateGoogleApiSource();checkCreateMessageBusProgress(name)
checkCreateMessageBusProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateMessageBus().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this message bus. */// const parent = 'abc123'/** * Required. The message bus to create. */// const messageBus = {}/** * Required. The user-provided ID to be assigned to the MessageBus. It should * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) */// const messageBusId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateMessageBus(){// Construct requestconstrequest={parent,messageBus,messageBusId,};// Run requestconst[operation]=awaiteventarcClient.createMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callCreateMessageBus();checkCreatePipelineProgress(name)
checkCreatePipelineProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreatePipeline().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this pipeline. */// const parent = 'abc123'/** * Required. The pipeline to create. */// const pipeline = {}/** * Required. The user-provided ID to be assigned to the Pipeline. */// const pipelineId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreatePipeline(){// Construct requestconstrequest={parent,pipeline,pipelineId,};// Run requestconst[operation]=awaiteventarcClient.createPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callCreatePipeline();checkCreateTriggerProgress(name)
checkCreateTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bycreateTrigger().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this trigger. */// const parent = 'abc123'/** * Required. The trigger to create. */// const trigger = {}/** * Required. The user-provided ID to be assigned to the trigger. */// const triggerId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateTrigger(){// Construct requestconstrequest={parent,trigger,triggerId,};// Run requestconst[operation]=awaiteventarcClient.createTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTrigger();checkDeleteChannelConnectionProgress(name)
checkDeleteChannelConnectionProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.ChannelConnection,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteChannelConnection().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.ChannelConnection,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel connection to delete. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteChannelConnection(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteChannelConnection(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteChannelConnection();checkDeleteChannelProgress(name)
checkDeleteChannelProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteChannel().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel to be deleted. */// const name = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteChannel(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteChannel(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteChannel();checkDeleteEnrollmentProgress(name)
checkDeleteEnrollmentProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteEnrollment().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the Enrollment to be deleted. */// const name = 'abc123'/** * Optional. If provided, the Enrollment will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the Enrollment is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteEnrollment(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteEnrollment();checkDeleteGoogleApiSourceProgress(name)
checkDeleteGoogleApiSourceProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteGoogleApiSource().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the GoogleApiSource to be deleted. */// const name = 'abc123'/** * Optional. If provided, the MessageBus will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the MessageBus is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteGoogleApiSource(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteGoogleApiSource();checkDeleteMessageBusProgress(name)
checkDeleteMessageBusProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteMessageBus().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the MessageBus to be deleted. */// const name = 'abc123'/** * Optional. If provided, the MessageBus will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the MessageBus is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteMessageBus(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteMessageBus();checkDeletePipelineProgress(name)
checkDeletePipelineProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeletePipeline().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the Pipeline to be deleted. */// const name = 'abc123'/** * Optional. If provided, the Pipeline will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the Pipeline is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeletePipeline(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deletePipeline(request);const[response]=awaitoperation.promise();console.log(response);}callDeletePipeline();checkDeleteTriggerProgress(name)
checkDeleteTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned bydeleteTrigger().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the trigger to be deleted. */// const name = 'abc123'/** * If provided, the trigger will only be deleted if the etag matches the * current etag on the resource. */// const etag = 'abc123'/** * If set to true, and the trigger is not found, the request will succeed * but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteTrigger(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTrigger();checkUpdateChannelProgress(name)
checkUpdateChannelProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdateChannel().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Channel,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * The channel to be updated. */// const channel = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateChannel(){// Construct requestconstrequest={};// Run requestconst[operation]=awaiteventarcClient.updateChannel(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateChannel();checkUpdateEnrollmentProgress(name)
checkUpdateEnrollmentProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdateEnrollment().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Enrollment,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The Enrollment to be updated. */// const enrollment = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the Enrollment is not found, a new Enrollment * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateEnrollment(){// Construct requestconstrequest={enrollment,};// Run requestconst[operation]=awaiteventarcClient.updateEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateEnrollment();checkUpdateGoogleApiSourceProgress(name)
checkUpdateGoogleApiSourceProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdateGoogleApiSource().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.GoogleApiSource,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The GoogleApiSource to be updated. */// const googleApiSource = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the GoogleApiSource is not found, a new * GoogleApiSource will be created. In this situation, `update_mask` is * ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateGoogleApiSource(){// Construct requestconstrequest={googleApiSource,};// Run requestconst[operation]=awaiteventarcClient.updateGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateGoogleApiSource();checkUpdateMessageBusProgress(name)
checkUpdateMessageBusProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdateMessageBus().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.MessageBus,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The MessageBus to be updated. */// const messageBus = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the MessageBus is not found, a new MessageBus * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateMessageBus(){// Construct requestconstrequest={messageBus,};// Run requestconst[operation]=awaiteventarcClient.updateMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateMessageBus();checkUpdatePipelineProgress(name)
checkUpdatePipelineProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdatePipeline().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Pipeline,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The Pipeline to be updated. */// const pipeline = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the Pipeline is not found, a new Pipeline * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdatePipeline(){// Construct requestconstrequest={pipeline,};// Run requestconst[operation]=awaiteventarcClient.updatePipeline(request);const[response]=awaitoperation.promise();console.log(response);}callUpdatePipeline();checkUpdateTriggerProgress(name)
checkUpdateTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;Check the status of the long running operation returned byupdateTrigger().
| Parameter | |
|---|---|
| Name | Description |
name | stringThe operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * The trigger to be updated. */// const trigger = {}/** * 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 "*". */// const updateMask = {}/** * If set to true, and the trigger is not found, a new trigger will be * created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateTrigger(){// Construct requestconstrequest={};// Run requestconst[operation]=awaiteventarcClient.updateTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTrigger();close()
close():Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns | |
|---|---|
| Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createChannel(request, options)
createChannel(request?:protos.google.cloud.eventarc.v1.ICreateChannelRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new channel in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this channel. */// const parent = 'abc123'/** * Required. The channel to create. */// const channel = {}/** * Required. The user-provided ID to be assigned to the channel. */// const channelId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateChannel(){// Construct requestconstrequest={parent,channel,channelId,};// Run requestconst[operation]=awaiteventarcClient.createChannel(request);const[response]=awaitoperation.promise();console.log(response);}callCreateChannel();createChannel(request, options, callback)
createChannel(request:protos.google.cloud.eventarc.v1.ICreateChannelRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createChannel(request, callback)
createChannel(request:protos.google.cloud.eventarc.v1.ICreateChannelRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createChannelConnection(request, options)
createChannelConnection(request?:protos.google.cloud.eventarc.v1.ICreateChannelConnectionRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new ChannelConnection in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelConnectionRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this channel connection. */// const parent = 'abc123'/** * Required. Channel connection to create. */// const channelConnection = {}/** * Required. The user-provided ID to be assigned to the channel connection. */// const channelConnectionId = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateChannelConnection(){// Construct requestconstrequest={parent,channelConnection,channelConnectionId,};// Run requestconst[operation]=awaiteventarcClient.createChannelConnection(request);const[response]=awaitoperation.promise();console.log(response);}callCreateChannelConnection();createChannelConnection(request, options, callback)
createChannelConnection(request:protos.google.cloud.eventarc.v1.ICreateChannelConnectionRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelConnectionRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createChannelConnection(request, callback)
createChannelConnection(request:protos.google.cloud.eventarc.v1.ICreateChannelConnectionRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateChannelConnectionRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createEnrollment(request, options)
createEnrollment(request?:protos.google.cloud.eventarc.v1.ICreateEnrollmentRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new Enrollment in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateEnrollmentRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this enrollment. */// const parent = 'abc123'/** * Required. The enrollment to create. */// const enrollment = {}/** * Required. The user-provided ID to be assigned to the Enrollment. It should * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). */// const enrollmentId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateEnrollment(){// Construct requestconstrequest={parent,enrollment,enrollmentId,};// Run requestconst[operation]=awaiteventarcClient.createEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callCreateEnrollment();createEnrollment(request, options, callback)
createEnrollment(request:protos.google.cloud.eventarc.v1.ICreateEnrollmentRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateEnrollmentRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createEnrollment(request, callback)
createEnrollment(request:protos.google.cloud.eventarc.v1.ICreateEnrollmentRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateEnrollmentRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createGoogleApiSource(request, options)
createGoogleApiSource(request?:protos.google.cloud.eventarc.v1.ICreateGoogleApiSourceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new GoogleApiSource in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateGoogleApiSourceRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this google api source. */// const parent = 'abc123'/** * Required. The google api source to create. */// const googleApiSource = {}/** * Required. The user-provided ID to be assigned to the GoogleApiSource. It * should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). */// const googleApiSourceId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateGoogleApiSource(){// Construct requestconstrequest={parent,googleApiSource,googleApiSourceId,};// Run requestconst[operation]=awaiteventarcClient.createGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callCreateGoogleApiSource();createGoogleApiSource(request, options, callback)
createGoogleApiSource(request:protos.google.cloud.eventarc.v1.ICreateGoogleApiSourceRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateGoogleApiSourceRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createGoogleApiSource(request, callback)
createGoogleApiSource(request:protos.google.cloud.eventarc.v1.ICreateGoogleApiSourceRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateGoogleApiSourceRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createMessageBus(request, options)
createMessageBus(request?:protos.google.cloud.eventarc.v1.ICreateMessageBusRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new MessageBus in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateMessageBusRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this message bus. */// const parent = 'abc123'/** * Required. The message bus to create. */// const messageBus = {}/** * Required. The user-provided ID to be assigned to the MessageBus. It should * match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) */// const messageBusId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateMessageBus(){// Construct requestconstrequest={parent,messageBus,messageBusId,};// Run requestconst[operation]=awaiteventarcClient.createMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callCreateMessageBus();createMessageBus(request, options, callback)
createMessageBus(request:protos.google.cloud.eventarc.v1.ICreateMessageBusRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateMessageBusRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createMessageBus(request, callback)
createMessageBus(request:protos.google.cloud.eventarc.v1.ICreateMessageBusRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateMessageBusRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createPipeline(request, options)
createPipeline(request?:protos.google.cloud.eventarc.v1.ICreatePipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new Pipeline in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreatePipelineRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this pipeline. */// const parent = 'abc123'/** * Required. The pipeline to create. */// const pipeline = {}/** * Required. The user-provided ID to be assigned to the Pipeline. */// const pipelineId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreatePipeline(){// Construct requestconstrequest={parent,pipeline,pipelineId,};// Run requestconst[operation]=awaiteventarcClient.createPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callCreatePipeline();createPipeline(request, options, callback)
createPipeline(request:protos.google.cloud.eventarc.v1.ICreatePipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreatePipelineRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createPipeline(request, callback)
createPipeline(request:protos.google.cloud.eventarc.v1.ICreatePipelineRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreatePipelineRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createTrigger(request, options)
createTrigger(request?:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Create a new trigger in a particular project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ICreateTriggerRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection in which to add this trigger. */// const parent = 'abc123'/** * Required. The trigger to create. */// const trigger = {}/** * Required. The user-provided ID to be assigned to the trigger. */// const triggerId = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateTrigger(){// Construct requestconstrequest={parent,trigger,triggerId,};// Run requestconst[operation]=awaiteventarcClient.createTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTrigger();createTrigger(request, options, callback)
createTrigger(request:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateTriggerRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
createTrigger(request, callback)
createTrigger(request:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ICreateTriggerRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteChannel(request, options)
deleteChannel(request?:protos.google.cloud.eventarc.v1.IDeleteChannelRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single channel.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel to be deleted. */// const name = 'abc123'/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteChannel(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteChannel(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteChannel();deleteChannel(request, options, callback)
deleteChannel(request:protos.google.cloud.eventarc.v1.IDeleteChannelRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteChannel(request, callback)
deleteChannel(request:protos.google.cloud.eventarc.v1.IDeleteChannelRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteChannelConnection(request, options)
deleteChannelConnection(request?:protos.google.cloud.eventarc.v1.IDeleteChannelConnectionRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single ChannelConnection.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelConnectionRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel connection to delete. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteChannelConnection(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteChannelConnection(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteChannelConnection();deleteChannelConnection(request, options, callback)
deleteChannelConnection(request:protos.google.cloud.eventarc.v1.IDeleteChannelConnectionRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelConnectionRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteChannelConnection(request, callback)
deleteChannelConnection(request:protos.google.cloud.eventarc.v1.IDeleteChannelConnectionRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteChannelConnectionRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteEnrollment(request, options)
deleteEnrollment(request?:protos.google.cloud.eventarc.v1.IDeleteEnrollmentRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single Enrollment.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteEnrollmentRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the Enrollment to be deleted. */// const name = 'abc123'/** * Optional. If provided, the Enrollment will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the Enrollment is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteEnrollment(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteEnrollment();deleteEnrollment(request, options, callback)
deleteEnrollment(request:protos.google.cloud.eventarc.v1.IDeleteEnrollmentRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteEnrollmentRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteEnrollment(request, callback)
deleteEnrollment(request:protos.google.cloud.eventarc.v1.IDeleteEnrollmentRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteEnrollmentRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteGoogleApiSource(request, options)
deleteGoogleApiSource(request?:protos.google.cloud.eventarc.v1.IDeleteGoogleApiSourceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single GoogleApiSource.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGoogleApiSourceRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the GoogleApiSource to be deleted. */// const name = 'abc123'/** * Optional. If provided, the MessageBus will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the MessageBus is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteGoogleApiSource(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteGoogleApiSource();deleteGoogleApiSource(request, options, callback)
deleteGoogleApiSource(request:protos.google.cloud.eventarc.v1.IDeleteGoogleApiSourceRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGoogleApiSourceRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteGoogleApiSource(request, callback)
deleteGoogleApiSource(request:protos.google.cloud.eventarc.v1.IDeleteGoogleApiSourceRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGoogleApiSourceRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteMessageBus(request, options)
deleteMessageBus(request?:protos.google.cloud.eventarc.v1.IDeleteMessageBusRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single message bus.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteMessageBusRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the MessageBus to be deleted. */// const name = 'abc123'/** * Optional. If provided, the MessageBus will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the MessageBus is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteMessageBus(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteMessageBus();deleteMessageBus(request, options, callback)
deleteMessageBus(request:protos.google.cloud.eventarc.v1.IDeleteMessageBusRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteMessageBusRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteMessageBus(request, callback)
deleteMessageBus(request:protos.google.cloud.eventarc.v1.IDeleteMessageBusRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteMessageBusRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteOperation(request, optionsOrCallback, callback)
deleteOperation(request:protos.google.longrunning.DeleteOperationRequest,optionsOrCallback?:gax.CallOptions|Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest,{}|null|undefined>,callback?:Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest,{}|null|undefined>):Promise<protos.google.protobuf.Empty>;Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteOperationRequestThe request object that will be sent. |
optionsOrCallback | CallOptions |Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> |
callback | Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> | |
constclient=longrunning.operationsClient();awaitclient.deleteOperation({name:''});deletePipeline(request, options)
deletePipeline(request?:protos.google.cloud.eventarc.v1.IDeletePipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single pipeline.
| Parameters | |
|---|---|
| Name | Description |
request | IDeletePipelineRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the Pipeline to be deleted. */// const name = 'abc123'/** * Optional. If provided, the Pipeline will only be deleted if the etag * matches the current etag on the resource. */// const etag = 'abc123'/** * Optional. If set to true, and the Pipeline is not found, the request will * succeed but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeletePipeline(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deletePipeline(request);const[response]=awaitoperation.promise();console.log(response);}callDeletePipeline();deletePipeline(request, options, callback)
deletePipeline(request:protos.google.cloud.eventarc.v1.IDeletePipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeletePipelineRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deletePipeline(request, callback)
deletePipeline(request:protos.google.cloud.eventarc.v1.IDeletePipelineRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeletePipelineRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteTrigger(request, options)
deleteTrigger(request?:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Delete a single trigger.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteTriggerRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the trigger to be deleted. */// const name = 'abc123'/** * If provided, the trigger will only be deleted if the etag matches the * current etag on the resource. */// const etag = 'abc123'/** * If set to true, and the trigger is not found, the request will succeed * but no action will be taken on the server. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteTrigger(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaiteventarcClient.deleteTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTrigger();deleteTrigger(request, options, callback)
deleteTrigger(request:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteTriggerRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteTrigger(request, callback)
deleteTrigger(request:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteTriggerRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
enrollmentPath(project, location, enrollment)
enrollmentPath(project:string,location:string,enrollment:string):string;Return a fully-qualified enrollment resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
enrollment | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
getChannel(request, options)
getChannel(request?:protos.google.cloud.eventarc.v1.IGetChannelRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest|undefined,{}|undefined]>;Get a single Channel.
| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetChannel(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getChannel(request);console.log(response);}callGetChannel();getChannel(request, options, callback)
getChannel(request:protos.google.cloud.eventarc.v1.IGetChannelRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getChannel(request, callback)
getChannel(request:protos.google.cloud.eventarc.v1.IGetChannelRequest,callback:Callback<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IGetChannelRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getChannelConnection(request, options)
getChannelConnection(request?:protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest|undefined,{}|undefined]>;Get a single ChannelConnection.
| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelConnectionRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingChannelConnection. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the channel connection to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetChannelConnection(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getChannelConnection(request);console.log(response);}callGetChannelConnection();getChannelConnection(request, options, callback)
getChannelConnection(request:protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelConnectionRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getChannelConnection(request, callback)
getChannelConnection(request:protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest,callback:Callback<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetChannelConnectionRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IChannelConnection,protos.google.cloud.eventarc.v1.IGetChannelConnectionRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getEnrollment(request, options)
getEnrollment(request?:protos.google.cloud.eventarc.v1.IGetEnrollmentRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest|undefined,{}|undefined]>;Get a single Enrollment.
| Parameters | |
|---|---|
| Name | Description |
request | IGetEnrollmentRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingEnrollment. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the Enrollment to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetEnrollment(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getEnrollment(request);console.log(response);}callGetEnrollment();getEnrollment(request, options, callback)
getEnrollment(request:protos.google.cloud.eventarc.v1.IGetEnrollmentRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetEnrollmentRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getEnrollment(request, callback)
getEnrollment(request:protos.google.cloud.eventarc.v1.IGetEnrollmentRequest,callback:Callback<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetEnrollmentRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IGetEnrollmentRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getGoogleApiSource(request, options)
getGoogleApiSource(request?:protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest|undefined,{}|undefined]>;Get a single GoogleApiSource.
| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleApiSourceRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingGoogleApiSource. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the google api source to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetGoogleApiSource(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getGoogleApiSource(request);console.log(response);}callGetGoogleApiSource();getGoogleApiSource(request, options, callback)
getGoogleApiSource(request:protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleApiSourceRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getGoogleApiSource(request, callback)
getGoogleApiSource(request:protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleApiSourceRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IGetGoogleApiSourceRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getGoogleChannelConfig(request, options)
getGoogleChannelConfig(request?:protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IGoogleChannelConfig,(protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest|undefined),{}|undefined]>;Get a GoogleChannelConfig
| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleChannelConfigRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IGoogleChannelConfig, (protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingGoogleChannelConfig. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the config to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetGoogleChannelConfig(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getGoogleChannelConfig(request);console.log(response);}callGetGoogleChannelConfig();getGoogleChannelConfig(request, options, callback)
getGoogleChannelConfig(request:protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleChannelConfigRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getGoogleChannelConfig(request, callback)
getGoogleChannelConfig(request:protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGoogleChannelConfigRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IGetGoogleChannelConfigRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getIamPolicy(request, options, callback)
getIamPolicy(request:IamProtos.google.iam.v1.GetIamPolicyRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.GetIamPolicyRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.GetIamPolicyRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.Policy]>;Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
request | IamProtos.google.iam.v1.GetIamPolicyRequestThe request object that will be sent. |
options | CallOptions |Callback<google.iam.v1.Policy,google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details. |
callback | Callback<google.iam.v1.Policy,google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.Policy]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
getLocation(request, options, callback)
getLocation(request:LocationProtos.google.cloud.location.IGetLocationRequest,options?:gax.CallOptions|Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>,callback?:Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>):Promise<LocationProtos.google.cloud.location.ILocation>;Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request | LocationProtos.google.cloud.location.IGetLocationRequestThe request object that will be sent. |
options | CallOptions |Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>Call options. SeeCallOptions for more details. |
callback | Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
const[response]=awaitclient.getLocation(request);getMessageBus(request, options)
getMessageBus(request?:protos.google.cloud.eventarc.v1.IGetMessageBusRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest|undefined,{}|undefined]>;Get a single MessageBus.
| Parameters | |
|---|---|
| Name | Description |
request | IGetMessageBusRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingMessageBus. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the message bus to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetMessageBus(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getMessageBus(request);console.log(response);}callGetMessageBus();getMessageBus(request, options, callback)
getMessageBus(request:protos.google.cloud.eventarc.v1.IGetMessageBusRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetMessageBusRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getMessageBus(request, callback)
getMessageBus(request:protos.google.cloud.eventarc.v1.IGetMessageBusRequest,callback:Callback<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetMessageBusRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IGetMessageBusRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getOperation(request, optionsOrCallback, callback)
getOperation(request:protos.google.longrunning.GetOperationRequest,optionsOrCallback?:gax.CallOptions|Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest,{}|null|undefined>,callback?:Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest,{}|null|undefined>):Promise<[protos.google.longrunning.Operation]>;Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request | GetOperationRequestThe request object that will be sent. |
optionsOrCallback | CallOptions |Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest, {} | null | undefined> |
callback | Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest, {} | null | undefined>The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.longrunning.Operation]> | |
constclient=longrunning.operationsClient();constname='';const[response]=awaitclient.getOperation({name});// doThingsWith(response)getPipeline(request, options)
getPipeline(request?:protos.google.cloud.eventarc.v1.IGetPipelineRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest|undefined,{}|undefined]>;Get a single Pipeline.
| Parameters | |
|---|---|
| Name | Description |
request | IGetPipelineRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the pipeline to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetPipeline(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getPipeline(request);console.log(response);}callGetPipeline();getPipeline(request, options, callback)
getPipeline(request:protos.google.cloud.eventarc.v1.IGetPipelineRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetPipelineRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getPipeline(request, callback)
getPipeline(request:protos.google.cloud.eventarc.v1.IGetPipelineRequest,callback:Callback<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetPipelineRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IGetPipelineRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getProjectId()
getProjectId():Promise<string>;| Returns | |
|---|---|
| Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback:Callback<string,undefined,undefined>):void;| Parameter | |
|---|---|
| Name | Description |
callback | Callback<string, undefined, undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getProvider(request, options)
getProvider(request?:protos.google.cloud.eventarc.v1.IGetProviderRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest|undefined,{}|undefined]>;Get a single Provider.
| Parameters | |
|---|---|
| Name | Description |
request | IGetProviderRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingProvider. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the provider to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetProvider(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getProvider(request);console.log(response);}callGetProvider();getProvider(request, options, callback)
getProvider(request:protos.google.cloud.eventarc.v1.IGetProviderRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetProviderRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getProvider(request, callback)
getProvider(request:protos.google.cloud.eventarc.v1.IGetProviderRequest,callback:Callback<protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetProviderRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IProvider,protos.google.cloud.eventarc.v1.IGetProviderRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getTrigger(request, options)
getTrigger(request?:protos.google.cloud.eventarc.v1.IGetTriggerRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|undefined,{}|undefined]>;Get a single trigger.
| Parameters | |
|---|---|
| Name | Description |
request | IGetTriggerRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingTrigger. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The name of the trigger to get. */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetTrigger(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getTrigger(request);console.log(response);}callGetTrigger();getTrigger(request, options, callback)
getTrigger(request:protos.google.cloud.eventarc.v1.IGetTriggerRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetTriggerRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getTrigger(request, callback)
getTrigger(request:protos.google.cloud.eventarc.v1.IGetTriggerRequest,callback:Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetTriggerRequest |
callback | Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
googleApiSourcePath(project, location, googleApiSource)
googleApiSourcePath(project:string,location:string,googleApiSource:string):string;Return a fully-qualified googleApiSource resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
googleApiSource | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
googleChannelConfigPath(project, location)
googleChannelConfigPath(project:string,location:string):string;Return a fully-qualified googleChannelConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
initialize()
initialize():Promise<{[name:string]:Function;}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns | |
|---|---|
| Type | Description |
Promise<{ [name: string]:Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
listChannelConnections(request, options)
listChannelConnections(request?:protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IChannelConnection[],protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest|null,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse]>;List channel connections.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelConnectionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IChannelConnection[],protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest | null,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofChannelConnection. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listChannelConnections(request, options, callback)
listChannelConnections(request:protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse|null|undefined,protos.google.cloud.eventarc.v1.IChannelConnection>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListChannelConnectionsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse | null | undefined,protos.google.cloud.eventarc.v1.IChannelConnection> |
| Returns | |
|---|---|
| Type | Description |
void | |
listChannelConnections(request, callback)
listChannelConnections(request:protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse|null|undefined,protos.google.cloud.eventarc.v1.IChannelConnection>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListChannelConnectionsRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,protos.google.cloud.eventarc.v1.IListChannelConnectionsResponse | null | undefined,protos.google.cloud.eventarc.v1.IChannelConnection> |
| Returns | |
|---|---|
| Type | Description |
void | |
listChannelConnectionsAsync(request, options)
listChannelConnectionsAsync(request?:protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IChannelConnection>;Equivalent tolistChannelConnections, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelConnectionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IChannelConnection> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingChannelConnection. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection from which to list channel connections. */// const parent = 'abc123'/** * The maximum number of channel connections to return on each page. * Note: The service may send fewer responses. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListChannelConnections(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listChannelConnectionsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListChannelConnections();listChannelConnectionsStream(request, options)
listChannelConnectionsStream(request?:protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest,options?:CallOptions):Transform;Equivalent tolistChannelConnections, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelConnectionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingChannelConnection on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listChannels(request, options)
listChannels(request?:protos.google.cloud.eventarc.v1.IListChannelsRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IChannel[],protos.google.cloud.eventarc.v1.IListChannelsRequest|null,protos.google.cloud.eventarc.v1.IListChannelsResponse]>;List channels.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IChannel[],protos.google.cloud.eventarc.v1.IListChannelsRequest | null,protos.google.cloud.eventarc.v1.IListChannelsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listChannels(request, options, callback)
listChannels(request:protos.google.cloud.eventarc.v1.IListChannelsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelsRequest,protos.google.cloud.eventarc.v1.IListChannelsResponse|null|undefined,protos.google.cloud.eventarc.v1.IChannel>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListChannelsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelsRequest,protos.google.cloud.eventarc.v1.IListChannelsResponse | null | undefined,protos.google.cloud.eventarc.v1.IChannel> |
| Returns | |
|---|---|
| Type | Description |
void | |
listChannels(request, callback)
listChannels(request:protos.google.cloud.eventarc.v1.IListChannelsRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelsRequest,protos.google.cloud.eventarc.v1.IListChannelsResponse|null|undefined,protos.google.cloud.eventarc.v1.IChannel>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListChannelsRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListChannelsRequest,protos.google.cloud.eventarc.v1.IListChannelsResponse | null | undefined,protos.google.cloud.eventarc.v1.IChannel> |
| Returns | |
|---|---|
| Type | Description |
void | |
listChannelsAsync(request, options)
listChannelsAsync(request?:protos.google.cloud.eventarc.v1.IListChannelsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IChannel>;Equivalent tolistChannels, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IChannel> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list channels on. */// const parent = 'abc123'/** * The maximum number of channels to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListChannels(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listChannelsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListChannels();listChannelsStream(request, options)
listChannelsStream(request?:protos.google.cloud.eventarc.v1.IListChannelsRequest,options?:CallOptions):Transform;Equivalent tolistChannels, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListChannelsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listEnrollments(request, options)
listEnrollments(request?:protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IEnrollment[],protos.google.cloud.eventarc.v1.IListEnrollmentsRequest|null,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse]>;List Enrollments.
| Parameters | |
|---|---|
| Name | Description |
request | IListEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IEnrollment[],protos.google.cloud.eventarc.v1.IListEnrollmentsRequest | null,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofEnrollment. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listEnrollments(request, options, callback)
listEnrollments(request:protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse|null|undefined,protos.google.cloud.eventarc.v1.IEnrollment>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListEnrollmentsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse | null | undefined,protos.google.cloud.eventarc.v1.IEnrollment> |
| Returns | |
|---|---|
| Type | Description |
void | |
listEnrollments(request, callback)
listEnrollments(request:protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse|null|undefined,protos.google.cloud.eventarc.v1.IEnrollment>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListEnrollmentsRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListEnrollmentsResponse | null | undefined,protos.google.cloud.eventarc.v1.IEnrollment> |
| Returns | |
|---|---|
| Type | Description |
void | |
listEnrollmentsAsync(request, options)
listEnrollmentsAsync(request?:protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IEnrollment>;Equivalent tolistEnrollments, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IEnrollment> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingEnrollment. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list triggers on. */// const parent = 'abc123'/** * Optional. The maximum number of results to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * Optional. The filter field that the list request will filter on. * Possible filtersare described in https://google.aip.dev/160. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListEnrollments(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listEnrollmentsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListEnrollments();listEnrollmentsStream(request, options)
listEnrollmentsStream(request?:protos.google.cloud.eventarc.v1.IListEnrollmentsRequest,options?:CallOptions):Transform;Equivalent tolistEnrollments, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingEnrollment on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listGoogleApiSources(request, options)
listGoogleApiSources(request?:protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IGoogleApiSource[],protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest|null,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse]>;List GoogleApiSources.
| Parameters | |
|---|---|
| Name | Description |
request | IListGoogleApiSourcesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IGoogleApiSource[],protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest | null,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofGoogleApiSource. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listGoogleApiSources(request, options, callback)
listGoogleApiSources(request:protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse|null|undefined,protos.google.cloud.eventarc.v1.IGoogleApiSource>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListGoogleApiSourcesRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse | null | undefined,protos.google.cloud.eventarc.v1.IGoogleApiSource> |
| Returns | |
|---|---|
| Type | Description |
void | |
listGoogleApiSources(request, callback)
listGoogleApiSources(request:protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse|null|undefined,protos.google.cloud.eventarc.v1.IGoogleApiSource>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListGoogleApiSourcesRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,protos.google.cloud.eventarc.v1.IListGoogleApiSourcesResponse | null | undefined,protos.google.cloud.eventarc.v1.IGoogleApiSource> |
| Returns | |
|---|---|
| Type | Description |
void | |
listGoogleApiSourcesAsync(request, options)
listGoogleApiSourcesAsync(request?:protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IGoogleApiSource>;Equivalent tolistGoogleApiSources, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListGoogleApiSourcesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IGoogleApiSource> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingGoogleApiSource. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list GoogleApiSources on. */// const parent = 'abc123'/** * Optional. The maximum number of results to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * Optional. The filter field that the list request will filter on. * Possible filtersare described in https://google.aip.dev/160. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListGoogleApiSources(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listGoogleApiSourcesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListGoogleApiSources();listGoogleApiSourcesStream(request, options)
listGoogleApiSourcesStream(request?:protos.google.cloud.eventarc.v1.IListGoogleApiSourcesRequest,options?:CallOptions):Transform;Equivalent tolistGoogleApiSources, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListGoogleApiSourcesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingGoogleApiSource on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listLocationsAsync(request, options)
listLocationsAsync(request:LocationProtos.google.cloud.location.IListLocationsRequest,options?:CallOptions):AsyncIterable<LocationProtos.google.cloud.location.ILocation>;Lists information about the supported locations for this service. Returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | LocationProtos.google.cloud.location.IListLocationsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
constiterable=client.listLocationsAsync(request);forawait(constresponseofiterable){// process response}listMessageBusEnrollments(request, options)
listMessageBusEnrollments(request?:protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,options?:CallOptions):Promise<[string[],protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest|null,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse]>;List message bus enrollments.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[ string[],protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest | null,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of string. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listMessageBusEnrollments(request, options, callback)
listMessageBusEnrollments(request:protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse|null|undefined,string>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusEnrollmentsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse | null | undefined, string> |
| Returns | |
|---|---|
| Type | Description |
void | |
listMessageBusEnrollments(request, callback)
listMessageBusEnrollments(request:protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse|null|undefined,string>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusEnrollmentsRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsResponse | null | undefined, string> |
| Returns | |
|---|---|
| Type | Description |
void | |
listMessageBusEnrollmentsAsync(request, options)
listMessageBusEnrollmentsAsync(request?:protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,options?:CallOptions):AsyncIterable<string>;Equivalent tolistMessageBusEnrollments, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<string> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing string. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent message bus to list enrollments on. */// const parent = 'abc123'/** * Optional. The maximum number of results to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListMessageBusEnrollments(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listMessageBusEnrollmentsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListMessageBusEnrollments();listMessageBusEnrollmentsStream(request, options)
listMessageBusEnrollmentsStream(request?:protos.google.cloud.eventarc.v1.IListMessageBusEnrollmentsRequest,options?:CallOptions):Transform;Equivalent tolistMessageBusEnrollments, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusEnrollmentsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing string on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listMessageBuses(request, options)
listMessageBuses(request?:protos.google.cloud.eventarc.v1.IListMessageBusesRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IMessageBus[],protos.google.cloud.eventarc.v1.IListMessageBusesRequest|null,protos.google.cloud.eventarc.v1.IListMessageBusesResponse]>;List message buses.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IMessageBus[],protos.google.cloud.eventarc.v1.IListMessageBusesRequest | null,protos.google.cloud.eventarc.v1.IListMessageBusesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofMessageBus. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listMessageBuses(request, options, callback)
listMessageBuses(request:protos.google.cloud.eventarc.v1.IListMessageBusesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusesRequest,protos.google.cloud.eventarc.v1.IListMessageBusesResponse|null|undefined,protos.google.cloud.eventarc.v1.IMessageBus>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusesRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusesRequest,protos.google.cloud.eventarc.v1.IListMessageBusesResponse | null | undefined,protos.google.cloud.eventarc.v1.IMessageBus> |
| Returns | |
|---|---|
| Type | Description |
void | |
listMessageBuses(request, callback)
listMessageBuses(request:protos.google.cloud.eventarc.v1.IListMessageBusesRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusesRequest,protos.google.cloud.eventarc.v1.IListMessageBusesResponse|null|undefined,protos.google.cloud.eventarc.v1.IMessageBus>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusesRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListMessageBusesRequest,protos.google.cloud.eventarc.v1.IListMessageBusesResponse | null | undefined,protos.google.cloud.eventarc.v1.IMessageBus> |
| Returns | |
|---|---|
| Type | Description |
void | |
listMessageBusesAsync(request, options)
listMessageBusesAsync(request?:protos.google.cloud.eventarc.v1.IListMessageBusesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IMessageBus>;Equivalent tolistMessageBuses, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IMessageBus> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingMessageBus. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list triggers on. */// const parent = 'abc123'/** * Optional. The maximum number of results to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * Optional. The filter field that the list request will filter on. * Possible filtersare described in https://google.aip.dev/160. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListMessageBuses(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listMessageBusesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListMessageBuses();listMessageBusesStream(request, options)
listMessageBusesStream(request?:protos.google.cloud.eventarc.v1.IListMessageBusesRequest,options?:CallOptions):Transform;Equivalent tolistMessageBuses, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListMessageBusesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingMessageBus on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listOperationsAsync(request, options)
listOperationsAsync(request:protos.google.longrunning.ListOperationsRequest,options?:gax.CallOptions):AsyncIterable<protos.google.longrunning.IOperation>;Lists operations that match the specified filter in the request. If the server doesn't support this method, it returnsUNIMPLEMENTED. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | ListOperationsRequestThe request object that will be sent. |
options | CallOptionsOptional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.longrunning.IOperation> | {Object} An iterable Object that conforms toiteration protocols. |
constclient=longrunning.operationsClient();forawait(constresponseofclient.listOperationsAsync(request));// doThingsWith(response)listPipelines(request, options)
listPipelines(request?:protos.google.cloud.eventarc.v1.IListPipelinesRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IPipeline[],protos.google.cloud.eventarc.v1.IListPipelinesRequest|null,protos.google.cloud.eventarc.v1.IListPipelinesResponse]>;List pipelines.
| Parameters | |
|---|---|
| Name | Description |
request | IListPipelinesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IPipeline[],protos.google.cloud.eventarc.v1.IListPipelinesRequest | null,protos.google.cloud.eventarc.v1.IListPipelinesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPipelines(request, options, callback)
listPipelines(request:protos.google.cloud.eventarc.v1.IListPipelinesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListPipelinesRequest,protos.google.cloud.eventarc.v1.IListPipelinesResponse|null|undefined,protos.google.cloud.eventarc.v1.IPipeline>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListPipelinesRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListPipelinesRequest,protos.google.cloud.eventarc.v1.IListPipelinesResponse | null | undefined,protos.google.cloud.eventarc.v1.IPipeline> |
| Returns | |
|---|---|
| Type | Description |
void | |
listPipelines(request, callback)
listPipelines(request:protos.google.cloud.eventarc.v1.IListPipelinesRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListPipelinesRequest,protos.google.cloud.eventarc.v1.IListPipelinesResponse|null|undefined,protos.google.cloud.eventarc.v1.IPipeline>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListPipelinesRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListPipelinesRequest,protos.google.cloud.eventarc.v1.IListPipelinesResponse | null | undefined,protos.google.cloud.eventarc.v1.IPipeline> |
| Returns | |
|---|---|
| Type | Description |
void | |
listPipelinesAsync(request, options)
listPipelinesAsync(request?:protos.google.cloud.eventarc.v1.IListPipelinesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IPipeline>;Equivalent tolistPipelines, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListPipelinesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IPipeline> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list pipelines on. */// const parent = 'abc123'/** * Optional. The maximum number of results to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * Optional. The filter field that the list request will filter on. * Possible filters are described in https://google.aip.dev/160. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListPipelines(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listPipelinesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListPipelines();listPipelinesStream(request, options)
listPipelinesStream(request?:protos.google.cloud.eventarc.v1.IListPipelinesRequest,options?:CallOptions):Transform;Equivalent tolistPipelines, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListPipelinesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listProviders(request, options)
listProviders(request?:protos.google.cloud.eventarc.v1.IListProvidersRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IProvider[],protos.google.cloud.eventarc.v1.IListProvidersRequest|null,protos.google.cloud.eventarc.v1.IListProvidersResponse]>;List providers.
| Parameters | |
|---|---|
| Name | Description |
request | IListProvidersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IProvider[],protos.google.cloud.eventarc.v1.IListProvidersRequest | null,protos.google.cloud.eventarc.v1.IListProvidersResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofProvider. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listProviders(request, options, callback)
listProviders(request:protos.google.cloud.eventarc.v1.IListProvidersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListProvidersRequest,protos.google.cloud.eventarc.v1.IListProvidersResponse|null|undefined,protos.google.cloud.eventarc.v1.IProvider>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListProvidersRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListProvidersRequest,protos.google.cloud.eventarc.v1.IListProvidersResponse | null | undefined,protos.google.cloud.eventarc.v1.IProvider> |
| Returns | |
|---|---|
| Type | Description |
void | |
listProviders(request, callback)
listProviders(request:protos.google.cloud.eventarc.v1.IListProvidersRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListProvidersRequest,protos.google.cloud.eventarc.v1.IListProvidersResponse|null|undefined,protos.google.cloud.eventarc.v1.IProvider>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListProvidersRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListProvidersRequest,protos.google.cloud.eventarc.v1.IListProvidersResponse | null | undefined,protos.google.cloud.eventarc.v1.IProvider> |
| Returns | |
|---|---|
| Type | Description |
void | |
listProvidersAsync(request, options)
listProvidersAsync(request?:protos.google.cloud.eventarc.v1.IListProvidersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.IProvider>;Equivalent tolistProviders, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListProvidersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IProvider> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingProvider. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent of the provider to get. */// const parent = 'abc123'/** * The maximum number of providers to return on each page. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * The filter field that the list request will filter on. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListProviders(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listProvidersAsync(request);forawait(constresponseofiterable){console.log(response);}}callListProviders();listProvidersStream(request, options)
listProvidersStream(request?:protos.google.cloud.eventarc.v1.IListProvidersRequest,options?:CallOptions):Transform;Equivalent tolistProviders, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListProvidersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingProvider on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listTriggers(request, options)
listTriggers(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.ITrigger[],protos.google.cloud.eventarc.v1.IListTriggersRequest|null,protos.google.cloud.eventarc.v1.IListTriggersResponse]>;List triggers.
| Parameters | |
|---|---|
| Name | Description |
request | IListTriggersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.ITrigger[],protos.google.cloud.eventarc.v1.IListTriggersRequest | null,protos.google.cloud.eventarc.v1.IListTriggersResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array ofTrigger. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listTriggers(request, options, callback)
listTriggers(request:protos.google.cloud.eventarc.v1.IListTriggersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse|null|undefined,protos.google.cloud.eventarc.v1.ITrigger>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListTriggersRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined,protos.google.cloud.eventarc.v1.ITrigger> |
| Returns | |
|---|---|
| Type | Description |
void | |
listTriggers(request, callback)
listTriggers(request:protos.google.cloud.eventarc.v1.IListTriggersRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse|null|undefined,protos.google.cloud.eventarc.v1.ITrigger>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListTriggersRequest |
callback | PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined,protos.google.cloud.eventarc.v1.ITrigger> |
| Returns | |
|---|---|
| Type | Description |
void | |
listTriggersAsync(request, options)
listTriggersAsync(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger>;Equivalent tolistTriggers, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IListTriggersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingTrigger. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The parent collection to list triggers on. */// const parent = 'abc123'/** * The maximum number of triggers to return on each page. * Note: The service may send fewer. */// const pageSize = 1234/** * 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. */// const pageToken = 'abc123'/** * 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`. */// const orderBy = 'abc123'/** * 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. */// const filter = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListTriggers(){// Construct requestconstrequest={parent,};// Run requestconstiterable=eventarcClient.listTriggersAsync(request);forawait(constresponseofiterable){console.log(response);}}callListTriggers();listTriggersStream(request, options)
listTriggersStream(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):Transform;Equivalent tolistTriggers, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListTriggersRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representingTrigger on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
locationPath(project, location)
locationPath(project:string,location:string):string;Return a fully-qualified location resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
matchChannelConnectionFromChannelConnectionName(channelConnectionName)
matchChannelConnectionFromChannelConnectionName(channelConnectionName:string):string|number;Parse the channel_connection from ChannelConnection resource.
| Parameter | |
|---|---|
| Name | Description |
channelConnectionName | stringA fully-qualified path representing ChannelConnection resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the channel_connection. |
matchChannelFromChannelName(channelName)
matchChannelFromChannelName(channelName:string):string|number;Parse the channel from Channel resource.
| Parameter | |
|---|---|
| Name | Description |
channelName | stringA fully-qualified path representing Channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the channel. |
matchEnrollmentFromEnrollmentName(enrollmentName)
matchEnrollmentFromEnrollmentName(enrollmentName:string):string|number;Parse the enrollment from Enrollment resource.
| Parameter | |
|---|---|
| Name | Description |
enrollmentName | stringA fully-qualified path representing Enrollment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the enrollment. |
matchGoogleApiSourceFromGoogleApiSourceName(googleApiSourceName)
matchGoogleApiSourceFromGoogleApiSourceName(googleApiSourceName:string):string|number;Parse the google_api_source from GoogleApiSource resource.
| Parameter | |
|---|---|
| Name | Description |
googleApiSourceName | stringA fully-qualified path representing GoogleApiSource resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the google_api_source. |
matchLocationFromChannelConnectionName(channelConnectionName)
matchLocationFromChannelConnectionName(channelConnectionName:string):string|number;Parse the location from ChannelConnection resource.
| Parameter | |
|---|---|
| Name | Description |
channelConnectionName | stringA fully-qualified path representing ChannelConnection resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromChannelName(channelName)
matchLocationFromChannelName(channelName:string):string|number;Parse the location from Channel resource.
| Parameter | |
|---|---|
| Name | Description |
channelName | stringA fully-qualified path representing Channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromEnrollmentName(enrollmentName)
matchLocationFromEnrollmentName(enrollmentName:string):string|number;Parse the location from Enrollment resource.
| Parameter | |
|---|---|
| Name | Description |
enrollmentName | stringA fully-qualified path representing Enrollment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromGoogleApiSourceName(googleApiSourceName)
matchLocationFromGoogleApiSourceName(googleApiSourceName:string):string|number;Parse the location from GoogleApiSource resource.
| Parameter | |
|---|---|
| Name | Description |
googleApiSourceName | stringA fully-qualified path representing GoogleApiSource resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromGoogleChannelConfigName(googleChannelConfigName)
matchLocationFromGoogleChannelConfigName(googleChannelConfigName:string):string|number;Parse the location from GoogleChannelConfig resource.
| Parameter | |
|---|---|
| Name | Description |
googleChannelConfigName | stringA fully-qualified path representing GoogleChannelConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName:string):string|number;Parse the location from Location resource.
| Parameter | |
|---|---|
| Name | Description |
locationName | stringA fully-qualified path representing Location resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromMessageBusName(messageBusName)
matchLocationFromMessageBusName(messageBusName:string):string|number;Parse the location from MessageBus resource.
| Parameter | |
|---|---|
| Name | Description |
messageBusName | stringA fully-qualified path representing MessageBus resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromPipelineName(pipelineName)
matchLocationFromPipelineName(pipelineName:string):string|number;Parse the location from Pipeline resource.
| Parameter | |
|---|---|
| Name | Description |
pipelineName | stringA fully-qualified path representing Pipeline resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProviderName(providerName)
matchLocationFromProviderName(providerName:string):string|number;Parse the location from Provider resource.
| Parameter | |
|---|---|
| Name | Description |
providerName | stringA fully-qualified path representing Provider resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTriggerName(triggerName)
matchLocationFromTriggerName(triggerName:string):string|number;Parse the location from Trigger resource.
| Parameter | |
|---|---|
| Name | Description |
triggerName | stringA fully-qualified path representing Trigger resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the location. |
matchMessageBusFromMessageBusName(messageBusName)
matchMessageBusFromMessageBusName(messageBusName:string):string|number;Parse the message_bus from MessageBus resource.
| Parameter | |
|---|---|
| Name | Description |
messageBusName | stringA fully-qualified path representing MessageBus resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the message_bus. |
matchPipelineFromPipelineName(pipelineName)
matchPipelineFromPipelineName(pipelineName:string):string|number;Parse the pipeline from Pipeline resource.
| Parameter | |
|---|---|
| Name | Description |
pipelineName | stringA fully-qualified path representing Pipeline resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the pipeline. |
matchProjectFromChannelConnectionName(channelConnectionName)
matchProjectFromChannelConnectionName(channelConnectionName:string):string|number;Parse the project from ChannelConnection resource.
| Parameter | |
|---|---|
| Name | Description |
channelConnectionName | stringA fully-qualified path representing ChannelConnection resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromChannelName(channelName)
matchProjectFromChannelName(channelName:string):string|number;Parse the project from Channel resource.
| Parameter | |
|---|---|
| Name | Description |
channelName | stringA fully-qualified path representing Channel resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromEnrollmentName(enrollmentName)
matchProjectFromEnrollmentName(enrollmentName:string):string|number;Parse the project from Enrollment resource.
| Parameter | |
|---|---|
| Name | Description |
enrollmentName | stringA fully-qualified path representing Enrollment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromGoogleApiSourceName(googleApiSourceName)
matchProjectFromGoogleApiSourceName(googleApiSourceName:string):string|number;Parse the project from GoogleApiSource resource.
| Parameter | |
|---|---|
| Name | Description |
googleApiSourceName | stringA fully-qualified path representing GoogleApiSource resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromGoogleChannelConfigName(googleChannelConfigName)
matchProjectFromGoogleChannelConfigName(googleChannelConfigName:string):string|number;Parse the project from GoogleChannelConfig resource.
| Parameter | |
|---|---|
| Name | Description |
googleChannelConfigName | stringA fully-qualified path representing GoogleChannelConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName:string):string|number;Parse the project from Location resource.
| Parameter | |
|---|---|
| Name | Description |
locationName | stringA fully-qualified path representing Location resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromMessageBusName(messageBusName)
matchProjectFromMessageBusName(messageBusName:string):string|number;Parse the project from MessageBus resource.
| Parameter | |
|---|---|
| Name | Description |
messageBusName | stringA fully-qualified path representing MessageBus resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromPipelineName(pipelineName)
matchProjectFromPipelineName(pipelineName:string):string|number;Parse the project from Pipeline resource.
| Parameter | |
|---|---|
| Name | Description |
pipelineName | stringA fully-qualified path representing Pipeline resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName:string):string|number;Parse the project from Project resource.
| Parameter | |
|---|---|
| Name | Description |
projectName | stringA fully-qualified path representing Project resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProviderName(providerName)
matchProjectFromProviderName(providerName:string):string|number;Parse the project from Provider resource.
| Parameter | |
|---|---|
| Name | Description |
providerName | stringA fully-qualified path representing Provider resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTriggerName(triggerName)
matchProjectFromTriggerName(triggerName:string):string|number;Parse the project from Trigger resource.
| Parameter | |
|---|---|
| Name | Description |
triggerName | stringA fully-qualified path representing Trigger resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the project. |
matchProviderFromProviderName(providerName)
matchProviderFromProviderName(providerName:string):string|number;Parse the provider from Provider resource.
| Parameter | |
|---|---|
| Name | Description |
providerName | stringA fully-qualified path representing Provider resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the provider. |
matchTriggerFromTriggerName(triggerName)
matchTriggerFromTriggerName(triggerName:string):string|number;Parse the trigger from Trigger resource.
| Parameter | |
|---|---|
| Name | Description |
triggerName | stringA fully-qualified path representing Trigger resource. |
| Returns | |
|---|---|
| Type | Description |
string | number | {string} A string representing the trigger. |
messageBusPath(project, location, messageBus)
messageBusPath(project:string,location:string,messageBus:string):string;Return a fully-qualified messageBus resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
messageBus | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
pipelinePath(project, location, pipeline)
pipelinePath(project:string,location:string,pipeline:string):string;Return a fully-qualified pipeline resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
pipeline | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project:string):string;Return a fully-qualified project resource name string.
| Parameter | |
|---|---|
| Name | Description |
project | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
providerPath(project, location, provider)
providerPath(project:string,location:string,provider:string):string;Return a fully-qualified provider resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
provider | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
setIamPolicy(request, options, callback)
setIamPolicy(request:IamProtos.google.iam.v1.SetIamPolicyRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.SetIamPolicyRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.SetIamPolicyRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.Policy]>;Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
request | IamProtos.google.iam.v1.SetIamPolicyRequestThe request object that will be sent. |
options | CallOptions |Callback<google.iam.v1.Policy,google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details. |
callback | Callback<google.iam.v1.Policy,google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.Policy]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
testIamPermissions(request, options, callback)
testIamPermissions(request:IamProtos.google.iam.v1.TestIamPermissionsRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse,IamProtos.google.iam.v1.TestIamPermissionsRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse,IamProtos.google.iam.v1.TestIamPermissionsRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
request | IamProtos.google.iam.v1.TestIamPermissionsRequestThe request object that will be sent. |
options | CallOptions |Callback<google.iam.v1.TestIamPermissionsResponse,google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details. |
callback | Callback<google.iam.v1.TestIamPermissionsResponse,google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.TestIamPermissionsResponse]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
triggerPath(project, location, trigger)
triggerPath(project:string,location:string,trigger:string):string;Return a fully-qualified trigger resource name string.
| Parameters | |
|---|---|
| Name | Description |
project | string |
location | string |
trigger | string |
| Returns | |
|---|---|
| Type | Description |
string | {string} Resource name string. |
updateChannel(request, options)
updateChannel(request?:protos.google.cloud.eventarc.v1.IUpdateChannelRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single channel.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateChannelRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * The channel to be updated. */// const channel = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateChannel(){// Construct requestconstrequest={};// Run requestconst[operation]=awaiteventarcClient.updateChannel(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateChannel();updateChannel(request, options, callback)
updateChannel(request:protos.google.cloud.eventarc.v1.IUpdateChannelRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateChannelRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateChannel(request, callback)
updateChannel(request:protos.google.cloud.eventarc.v1.IUpdateChannelRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateChannelRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IChannel,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateEnrollment(request, options)
updateEnrollment(request?:protos.google.cloud.eventarc.v1.IUpdateEnrollmentRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single Enrollment.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateEnrollmentRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The Enrollment to be updated. */// const enrollment = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the Enrollment is not found, a new Enrollment * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateEnrollment(){// Construct requestconstrequest={enrollment,};// Run requestconst[operation]=awaiteventarcClient.updateEnrollment(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateEnrollment();updateEnrollment(request, options, callback)
updateEnrollment(request:protos.google.cloud.eventarc.v1.IUpdateEnrollmentRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateEnrollmentRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateEnrollment(request, callback)
updateEnrollment(request:protos.google.cloud.eventarc.v1.IUpdateEnrollmentRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateEnrollmentRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IEnrollment,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateGoogleApiSource(request, options)
updateGoogleApiSource(request?:protos.google.cloud.eventarc.v1.IUpdateGoogleApiSourceRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single GoogleApiSource.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleApiSourceRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The GoogleApiSource to be updated. */// const googleApiSource = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the GoogleApiSource is not found, a new * GoogleApiSource will be created. In this situation, `update_mask` is * ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateGoogleApiSource(){// Construct requestconstrequest={googleApiSource,};// Run requestconst[operation]=awaiteventarcClient.updateGoogleApiSource(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateGoogleApiSource();updateGoogleApiSource(request, options, callback)
updateGoogleApiSource(request:protos.google.cloud.eventarc.v1.IUpdateGoogleApiSourceRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleApiSourceRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateGoogleApiSource(request, callback)
updateGoogleApiSource(request:protos.google.cloud.eventarc.v1.IUpdateGoogleApiSourceRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleApiSourceRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IGoogleApiSource,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateGoogleChannelConfig(request, options)
updateGoogleChannelConfig(request?:protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.IGoogleChannelConfig,(protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest|undefined),{}|undefined]>;Update a single GoogleChannelConfig
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleChannelConfigRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.eventarc.v1.IGoogleChannelConfig, (protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingGoogleChannelConfig. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The config to be updated. */// const googleChannelConfig = {}/** * 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 "*". */// const updateMask = {}// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateGoogleChannelConfig(){// Construct requestconstrequest={googleChannelConfig,};// Run requestconstresponse=awaiteventarcClient.updateGoogleChannelConfig(request);console.log(response);}callUpdateGoogleChannelConfig();updateGoogleChannelConfig(request, options, callback)
updateGoogleChannelConfig(request:protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleChannelConfigRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateGoogleChannelConfig(request, callback)
updateGoogleChannelConfig(request:protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest,callback:Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateGoogleChannelConfigRequest |
callback | Callback<protos.google.cloud.eventarc.v1.IGoogleChannelConfig,protos.google.cloud.eventarc.v1.IUpdateGoogleChannelConfigRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateMessageBus(request, options)
updateMessageBus(request?:protos.google.cloud.eventarc.v1.IUpdateMessageBusRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single message bus.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateMessageBusRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The MessageBus to be updated. */// const messageBus = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the MessageBus is not found, a new MessageBus * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateMessageBus(){// Construct requestconstrequest={messageBus,};// Run requestconst[operation]=awaiteventarcClient.updateMessageBus(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateMessageBus();updateMessageBus(request, options, callback)
updateMessageBus(request:protos.google.cloud.eventarc.v1.IUpdateMessageBusRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateMessageBusRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateMessageBus(request, callback)
updateMessageBus(request:protos.google.cloud.eventarc.v1.IUpdateMessageBusRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateMessageBusRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IMessageBus,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updatePipeline(request, options)
updatePipeline(request?:protos.google.cloud.eventarc.v1.IUpdatePipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single pipeline.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdatePipelineRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Required. The Pipeline to be updated. */// const pipeline = {}/** * 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 "*". */// const updateMask = {}/** * Optional. If set to true, and the Pipeline is not found, a new Pipeline * will be created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdatePipeline(){// Construct requestconstrequest={pipeline,};// Run requestconst[operation]=awaiteventarcClient.updatePipeline(request);const[response]=awaitoperation.promise();console.log(response);}callUpdatePipeline();updatePipeline(request, options, callback)
updatePipeline(request:protos.google.cloud.eventarc.v1.IUpdatePipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdatePipelineRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updatePipeline(request, callback)
updatePipeline(request:protos.google.cloud.eventarc.v1.IUpdatePipelineRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdatePipelineRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.IPipeline,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateTrigger(request, options)
updateTrigger(request?:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;Update a single trigger.
| Parameters | |
|---|---|
| Name | Description |
request | IUpdateTriggerRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * The trigger to be updated. */// const trigger = {}/** * 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 "*". */// const updateMask = {}/** * If set to true, and the trigger is not found, a new trigger will be * created. In this situation, `update_mask` is ignored. */// const allowMissing = true/** * Optional. If set, validate the request and preview the review, but do not * post it. */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateTrigger(){// Construct requestconstrequest={};// Run requestconst[operation]=awaiteventarcClient.updateTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTrigger();updateTrigger(request, options, callback)
updateTrigger(request:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateTriggerRequest |
options | CallOptions |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
updateTrigger(request, callback)
updateTrigger(request:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IUpdateTriggerRequest |
callback | Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.