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?: typeof gax | typeof gax.fallback);
Construct an instance of EventarcClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): 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
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | 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 returns google.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 to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
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> |
const client = longrunning.operationsClient();
await client.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 by createChannelConnection()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateChannelConnection() {
// Construct request
const request = {
parent,
channelConnection,
channelConnectionId,
};
// Run request
const [operation] = await eventarcClient.createChannelConnection(request);
const [response] = await operation.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 by createChannel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateChannel() {
// Construct request
const request = {
parent,
channel,
channelId,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.createChannel(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateChannel();
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 by createTrigger()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateTrigger() {
// Construct request
const request = {
parent,
trigger,
triggerId,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.createTrigger(request);
const [response] = await operation.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 by deleteChannelConnection()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteChannelConnection() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await eventarcClient.deleteChannelConnection(request);
const [response] = await operation.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 by deleteChannel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteChannel() {
// Construct request
const request = {
name,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.deleteChannel(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteChannel();
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 by deleteTrigger()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteTrigger() {
// Construct request
const request = {
name,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.deleteTrigger(request);
const [response] = await operation.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 by updateChannel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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 = {}
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callUpdateChannel() {
// Construct request
const request = {
validateOnly,
};
// Run request
const [operation] = await eventarcClient.updateChannel(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateChannel();
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 by updateTrigger()
.
Parameter | |
---|---|
Name | Description |
name |
string
The 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 the documentation 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
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callUpdateTrigger() {
// Construct request
const request = {
validateOnly,
};
// Run request
const [operation] = await eventarcClient.updateTrigger(request);
const [response] = await operation.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 |
ICreateChannelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateChannel() {
// Construct request
const request = {
parent,
channel,
channelId,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.createChannel(request);
const [response] = await operation.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 |
ICreateChannelConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateChannelConnection() {
// Construct request
const request = {
parent,
channelConnection,
channelConnectionId,
};
// Run request
const [operation] = await eventarcClient.createChannelConnection(request);
const [response] = await operation.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 |
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 |
ICreateTriggerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callCreateTrigger() {
// Construct request
const request = {
parent,
trigger,
triggerId,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.createTrigger(request);
const [response] = await operation.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 |
IDeleteChannelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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'
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteChannel() {
// Construct request
const request = {
name,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.deleteChannel(request);
const [response] = await operation.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 |
IDeleteChannelConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteChannelConnection() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await eventarcClient.deleteChannelConnection(request);
const [response] = await operation.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 |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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 returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
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> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
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 |
IDeleteTriggerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callDeleteTrigger() {
// Construct request
const request = {
name,
validateOnly,
};
// Run request
const [operation] = await eventarcClient.deleteTrigger(request);
const [response] = await operation.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 |
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 |
IGetChannelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callGetChannel() {
// Construct request
const request = {
name,
};
// Run request
const response = await eventarcClient.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 |
IGetChannelConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 representing ChannelConnection. Please see the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callGetChannelConnection() {
// Construct request
const request = {
name,
};
// Run request
const response = await eventarcClient.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 |
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 |
IGetGoogleChannelConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 representing GoogleChannelConfig. Please see the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callGetGoogleChannelConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await eventarcClient.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.GetIamPolicyRequest
The 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. See gax.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.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions 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 the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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 |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
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]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
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 |
IGetProviderRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 representing Provider. Please see the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callGetProvider() {
// Construct request
const request = {
name,
};
// Run request
const response = await eventarcClient.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 |
IGetTriggerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 representing Trigger. Please see the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callGetTrigger() {
// Construct request
const request = {
name,
};
// Run request
const response = await eventarcClient.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 |
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 |
IListChannelConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 of ChannelConnection. 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 to listChannelConnections
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListChannelConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IChannelConnection> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ChannelConnection. 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callListChannelConnections() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = eventarcClient.listChannelConnectionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListChannelConnections();
listChannelConnectionsStream(request, options)
listChannelConnectionsStream(request?: protos.google.cloud.eventarc.v1.IListChannelConnectionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListChannelConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing ChannelConnection 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 |
IListChannelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 to listChannels
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListChannelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IChannel> | {Object} An iterable Object that allows async 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callListChannels() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = eventarcClient.listChannelsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListChannels();
listChannelsStream(request, options)
listChannelsStream(request?: protos.google.cloud.eventarc.v1.IListChannelsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListChannelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 |
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.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {Object} An iterable Object that allows async 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 the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
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 |
IListProvidersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 of Provider. 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 to listProviders
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListProvidersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.IProvider> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Provider. 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callListProviders() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = eventarcClient.listProvidersAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProviders();
listProvidersStream(request, options)
listProvidersStream(request?: protos.google.cloud.eventarc.v1.IListProvidersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListProvidersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing Provider 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 |
IListTriggersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 of Trigger. 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 to listTriggers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListTriggersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Trigger. 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 the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callListTriggers() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = eventarcClient.listTriggersAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListTriggers();
listTriggersStream(request, options)
listTriggersStream(request?: protos.google.cloud.eventarc.v1.IListTriggersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListTriggersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing Trigger 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 |
string
A 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 |
string
A fully-qualified path representing Channel resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the channel. |
matchLocationFromChannelConnectionName(channelConnectionName)
matchLocationFromChannelConnectionName(channelConnectionName: string): string | number;
Parse the location from ChannelConnection resource.
Parameter | |
---|---|
Name | Description |
channelConnectionName |
string
A 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 |
string
A fully-qualified path representing Channel 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 |
string
A 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 |
string
A fully-qualified path representing Location 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 |
string
A 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 |
string
A fully-qualified path representing Trigger resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromChannelConnectionName(channelConnectionName)
matchProjectFromChannelConnectionName(channelConnectionName: string): string | number;
Parse the project from ChannelConnection resource.
Parameter | |
---|---|
Name | Description |
channelConnectionName |
string
A 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 |
string
A fully-qualified path representing Channel 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 |
string
A 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 |
string
A fully-qualified path representing Location 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 |
string
A 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 |
string
A 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 |
string
A 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 |
string
A 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 |
string
A fully-qualified path representing Trigger resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the trigger. |
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.SetIamPolicyRequest
The 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. See gax.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.TestIamPermissionsRequest
The 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. See gax.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 |
IUpdateChannelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 = {}
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callUpdateChannel() {
// Construct request
const request = {
validateOnly,
};
// Run request
const [operation] = await eventarcClient.updateChannel(request);
const [response] = await operation.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 |
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 |
IUpdateGoogleChannelConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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 representing GoogleChannelConfig. Please see the documentation 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 library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callUpdateGoogleChannelConfig() {
// Construct request
const request = {
googleChannelConfig,
};
// Run request
const response = await eventarcClient.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 |
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 |
IUpdateTriggerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions 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
/**
* Required. If set, validate the request and preview the review, but do not
* post it.
*/
// const validateOnly = true
// Imports the Eventarc library
const {EventarcClient} = require('@google-cloud/eventarc').v1;
// Instantiates a client
const eventarcClient = new EventarcClient();
async function callUpdateTrigger() {
// Construct request
const request = {
validateOnly,
};
// Run request
const [operation] = await eventarcClient.updateTrigger(request);
const [response] = await operation.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 |