Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132562112.4 KB
projects

Create a new channel in a particular project and location.

post/v1/{+parent}/channels

Path parameters

parentstring required

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

Query parameters

channelIdstring

Required. The user-provided ID to be assigned to the channel.

validateOnlyboolean

Optional. If set, validate the request and preview the review, but do not post it.

Request body

satisfiesPzsboolean

Output only. Whether or not this Channel satisfies the requirements of physical zone separation

namestring

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.

state'STATE_UNSPECIFIED' | 'PENDING' | 'ACTIVE' | 'INACTIVE'

Output only. The state of a Channel.

cryptoKeyNamestring

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

pubsubTopicstring

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

updateTimestring google-datetime

Output only. The last-modified time.

activationTokenstring

Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

providerstring

The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.

labelsobject

Optional. Resource labels.

uidstring

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

createTimestring google-datetime

Output only. The creation time.

Response

Successful response