Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Eventarc

import { Eventarc } from "https://googleapis.deno.dev/v1/eventarc:v1.ts";

Build event-driven applications on Google Cloud Platform.

class Eventarc {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsChannelConnectionsCreate(
parent: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsChannelConnectionsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsChannelConnectionsGet(name: string): Promise<ChannelConnection>;
async projectsLocationsChannelConnectionsGetIamPolicy(resource: string, opts?: ProjectsLocationsChannelConnectionsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsChannelConnectionsList(parent: string, opts?: ProjectsLocationsChannelConnectionsListOptions): Promise<ListChannelConnectionsResponse>;
async projectsLocationsChannelConnectionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsChannelConnectionsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsChannelsCreate(
parent: string,
req: Channel,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsChannelsDelete(name: string, opts?: ProjectsLocationsChannelsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsChannelsGet(name: string): Promise<Channel>;
async projectsLocationsChannelsGetIamPolicy(resource: string, opts?: ProjectsLocationsChannelsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsChannelsList(parent: string, opts?: ProjectsLocationsChannelsListOptions): Promise<ListChannelsResponse>;
async projectsLocationsChannelsPatch(
name: string,
req: Channel,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsChannelsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsChannelsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsGetGoogleChannelConfig(name: string): Promise<GoogleChannelConfig>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
async projectsLocationsOperationsCancel(name: string, req: GoogleLongrunningCancelOperationRequest): Promise<Empty>;
async projectsLocationsOperationsDelete(name: string): Promise<Empty>;
async projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsProvidersGet(name: string): Promise<Provider>;
async projectsLocationsProvidersList(parent: string, opts?: ProjectsLocationsProvidersListOptions): Promise<ListProvidersResponse>;
async projectsLocationsTriggersCreate(
parent: string,
req: Trigger,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsTriggersDelete(name: string, opts?: ProjectsLocationsTriggersDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTriggersGet(name: string): Promise<Trigger>;
async projectsLocationsTriggersGetIamPolicy(resource: string, opts?: ProjectsLocationsTriggersGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsTriggersList(parent: string, opts?: ProjectsLocationsTriggersListOptions): Promise<ListTriggersResponse>;
async projectsLocationsTriggersPatch(
name: string,
req: Trigger,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsTriggersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsTriggersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsUpdateGoogleChannelConfig(
name: string,
): Promise<GoogleChannelConfig>;
}

§Constructors

§
new Eventarc(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsChannelConnectionsCreate(parent: string, req: ChannelConnection, opts?: ProjectsLocationsChannelConnectionsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Create a new ChannelConnection in a particular project and location.

@param parent

Required. The parent collection in which to add this channel connection.

§
projectsLocationsChannelConnectionsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Delete a single ChannelConnection.

@param name

Required. The name of the channel connection to delete.

§
projectsLocationsChannelConnectionsGet(name: string): Promise<ChannelConnection>
[src]

Get a single ChannelConnection.

@param name

Required. The name of the channel connection to get.

§
projectsLocationsChannelConnectionsGetIamPolicy(resource: string, opts?: ProjectsLocationsChannelConnectionsGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsChannelConnectionsList(parent: string, opts?: ProjectsLocationsChannelConnectionsListOptions): Promise<ListChannelConnectionsResponse>
[src]

List channel connections.

@param parent

Required. The parent collection from which to list channel connections.

§
projectsLocationsChannelConnectionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsChannelConnectionsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsChannelsCreate(parent: string, req: Channel, opts?: ProjectsLocationsChannelsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Create a new channel in a particular project and location.

@param parent

Required. The parent collection in which to add this channel.

§
projectsLocationsChannelsDelete(name: string, opts?: ProjectsLocationsChannelsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Delete a single channel.

@param name

Required. The name of the channel to be deleted.

§
projectsLocationsChannelsGet(name: string): Promise<Channel>
[src]

Get a single Channel.

@param name

Required. The name of the channel to get.

§
projectsLocationsChannelsGetIamPolicy(resource: string, opts?: ProjectsLocationsChannelsGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsChannelsList(parent: string, opts?: ProjectsLocationsChannelsListOptions): Promise<ListChannelsResponse>
[src]

List channels.

@param parent

Required. The parent collection to list channels on.

§
projectsLocationsChannelsPatch(name: string, req: Channel, opts?: ProjectsLocationsChannelsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Update a single channel.

@param name

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

§
projectsLocationsChannelsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsChannelsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsGetGoogleChannelConfig(name: string): Promise<GoogleChannelConfig>
[src]

Get a GoogleChannelConfig

@param name

Required. The name of the config to get.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsOperationsCancel(name: string, req: GoogleLongrunningCancelOperationRequest): Promise<Empty>
[src]

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 Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsDelete(name: string): Promise<Empty>
[src]

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.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

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.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsProvidersGet(name: string): Promise<Provider>
[src]

Get a single Provider.

@param name

Required. The name of the provider to get.

§
projectsLocationsProvidersList(parent: string, opts?: ProjectsLocationsProvidersListOptions): Promise<ListProvidersResponse>
[src]

List providers.

@param parent

Required. The parent of the provider to get.

§
projectsLocationsTriggersCreate(parent: string, req: Trigger, opts?: ProjectsLocationsTriggersCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Create a new trigger in a particular project and location.

@param parent

Required. The parent collection in which to add this trigger.

§
projectsLocationsTriggersDelete(name: string, opts?: ProjectsLocationsTriggersDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Delete a single trigger.

@param name

Required. The name of the trigger to be deleted.

§
projectsLocationsTriggersGet(name: string): Promise<Trigger>
[src]

Get a single trigger.

@param name

Required. The name of the trigger to get.

§
projectsLocationsTriggersGetIamPolicy(resource: string, opts?: ProjectsLocationsTriggersGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsTriggersList(parent: string, opts?: ProjectsLocationsTriggersListOptions): Promise<ListTriggersResponse>
[src]

List triggers.

@param parent

Required. The parent collection to list triggers on.

§
projectsLocationsTriggersPatch(name: string, req: Trigger, opts?: ProjectsLocationsTriggersPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Update a single trigger.

@param name

Required. The resource name of the trigger. Must be unique within the location of the project and must be in projects/{project}/locations/{location}/triggers/{trigger} format.

§
projectsLocationsTriggersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsTriggersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsUpdateGoogleChannelConfig(name: string, req: GoogleChannelConfig, opts?: ProjectsLocationsUpdateGoogleChannelConfigOptions): Promise<GoogleChannelConfig>
[src]

Update a single GoogleChannelConfig

@param name

Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.