google_api_sources

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

Overview

Name	google_api_sources
Type	Resource
Id	google.eventarc.google_api_sources

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
annotations	object	Optional. Resource annotations.
createTime	string (google-datetime)	Output only. The creation time.
cryptoKeyName	string	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/*.
destination	string	Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
displayName	string	Optional. Resource display name.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
labels	object	Optional. Resource labels.
loggingConfig	object	Optional. Config to control Platform logging for the GoogleApiSource. (id: LoggingConfig)
uid	string	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.
updateTime	string (google-datetime)	Output only. The last-modified time.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
annotations	object	Optional. Resource annotations.
createTime	string (google-datetime)	Output only. The creation time.
cryptoKeyName	string	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/*.
destination	string	Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
displayName	string	Optional. Resource display name.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
labels	object	Optional. Resource labels.
loggingConfig	object	Optional. Config to control Platform logging for the GoogleApiSource. (id: LoggingConfig)
uid	string	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.
updateTime	string (google-datetime)	Output only. The last-modified time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, googleApiSourcesId		Get a single GoogleApiSource.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy, filter	List GoogleApiSources.
create	insert	projectsId, locationsId	googleApiSourceId, validateOnly	Create a new GoogleApiSource in a particular project and location.
patch	update	projectsId, locationsId, googleApiSourcesId	updateMask, allowMissing, validateOnly	Update a single GoogleApiSource.
delete	delete	projectsId, locationsId, googleApiSourcesId	etag, allowMissing, validateOnly	Delete a single GoogleApiSource.

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.

Name	Datatype	Description
googleApiSourcesId	string
locationsId	string
projectsId	string
allowMissing	boolean
etag	string
filter	string
googleApiSourceId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Get a single GoogleApiSource.

SELECT
name,
annotations,
createTime,
cryptoKeyName,
destination,
displayName,
etag,
labels,
loggingConfig,
uid,
updateTime
FROM google.eventarc.google_api_sources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND googleApiSourcesId = '{{ googleApiSourcesId }}' -- required;

list

List GoogleApiSources.

SELECT
name,
annotations,
createTime,
cryptoKeyName,
destination,
displayName,
etag,
labels,
loggingConfig,
uid,
updateTime
FROM google.eventarc.google_api_sources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Create a new GoogleApiSource in a particular project and location.

INSERT INTO google.eventarc.google_api_sources (
data__name,
data__labels,
data__annotations,
data__displayName,
data__destination,
data__cryptoKeyName,
data__loggingConfig,
projectsId,
locationsId,
googleApiSourceId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ displayName }}',
'{{ destination }}',
'{{ cryptoKeyName }}',
'{{ loggingConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ googleApiSourceId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: google_api_sources
  props:
    - name: projectsId
      value: string
      description: Required parameter for the google_api_sources resource.
    - name: locationsId
      value: string
      description: Required parameter for the google_api_sources resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels.
        
    - name: annotations
      value: object
      description: >
        Optional. Resource annotations.
        
    - name: displayName
      value: string
      description: >
        Optional. Resource display name.
        
    - name: destination
      value: string
      description: >
        Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
        
    - name: cryptoKeyName
      value: string
      description: >
        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/*`.
        
    - name: loggingConfig
      value: object
      description: >
        Optional. Config to control Platform logging for the GoogleApiSource.
        
    - name: googleApiSourceId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Update a single GoogleApiSource.

UPDATE google.eventarc.google_api_sources
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}',
data__destination = '{{ destination }}',
data__cryptoKeyName = '{{ cryptoKeyName }}',
data__loggingConfig = '{{ loggingConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND googleApiSourcesId = '{{ googleApiSourcesId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a single GoogleApiSource.

DELETE FROM google.eventarc.google_api_sources
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND googleApiSourcesId = '{{ googleApiSourcesId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}';