Skip to main content

google_channel_config

Creates, updates, deletes, gets or lists a google_channel_config resource.

Overview

Namegoogle_channel_config
TypeResource
Idgoogle.eventarc.google_channel_config

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringRequired. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
cryptoKeyNamestringOptional. 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/*.
labelsobjectOptional. Resource labels.
updateTimestring (google-datetime)Output only. The last-modified time.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_google_channel_configselectprojectsId, locationsIdGet a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.
update_google_channel_configupdateprojectsId, locationsIdupdateMaskUpdate a single GoogleChannelConfig

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
updateMaskstring (google-fieldmask)

SELECT examples

Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.

SELECT
name,
cryptoKeyName,
labels,
updateTime
FROM google.eventarc.google_channel_config
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

Update a single GoogleChannelConfig

UPDATE google.eventarc.google_channel_config
SET
data__name = '{{ name }}',
data__cryptoKeyName = '{{ cryptoKeyName }}',
data__labels = '{{ labels }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
cryptoKeyName,
labels,
updateTime;