enrollments

Creates, updates, deletes, gets or lists an enrollments resource.

Overview

Name	enrollments
Type	Resource
Id	google.eventarc.enrollments

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}/enrollments/{enrollment}
annotations	object	Optional. Resource annotations.
celMatch	string	Required. A CEL expression identifying which messages this enrollment applies to.
createTime	string (google-datetime)	Output only. The creation time.
destination	string	Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_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.
messageBus	string	Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
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}/enrollments/{enrollment}
annotations	object	Optional. Resource annotations.
celMatch	string	Required. A CEL expression identifying which messages this enrollment applies to.
createTime	string (google-datetime)	Output only. The creation time.
destination	string	Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_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.
messageBus	string	Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
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, enrollmentsId		Get a single Enrollment.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy, filter	List Enrollments.
create	insert	projectsId, locationsId	enrollmentId, validateOnly	Create a new Enrollment in a particular project and location.
patch	update	projectsId, locationsId, enrollmentsId	updateMask, allowMissing, validateOnly	Update a single Enrollment.
delete	delete	projectsId, locationsId, enrollmentsId	etag, allowMissing, validateOnly	Delete a single Enrollment.

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
enrollmentsId	string
locationsId	string
projectsId	string
allowMissing	boolean
enrollmentId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Get a single Enrollment.

SELECT
name,
annotations,
celMatch,
createTime,
destination,
displayName,
etag,
labels,
messageBus,
uid,
updateTime
FROM google.eventarc.enrollments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND enrollmentsId = '{{ enrollmentsId }}' -- required;

list

List Enrollments.

SELECT
name,
annotations,
celMatch,
createTime,
destination,
displayName,
etag,
labels,
messageBus,
uid,
updateTime
FROM google.eventarc.enrollments
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 Enrollment in a particular project and location.

INSERT INTO google.eventarc.enrollments (
data__name,
data__labels,
data__annotations,
data__displayName,
data__celMatch,
data__messageBus,
data__destination,
projectsId,
locationsId,
enrollmentId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ displayName }}',
'{{ celMatch }}',
'{{ messageBus }}',
'{{ destination }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ enrollmentId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: enrollments
  props:
    - name: projectsId
      value: string
      description: Required parameter for the enrollments resource.
    - name: locationsId
      value: string
      description: Required parameter for the enrollments resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
        
    - 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: celMatch
      value: string
      description: >
        Required. A CEL expression identifying which messages this enrollment applies to.
        
    - name: messageBus
      value: string
      description: >
        Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
        
    - name: destination
      value: string
      description: >
        Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
        
    - name: enrollmentId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Update a single Enrollment.

UPDATE google.eventarc.enrollments
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}',
data__celMatch = '{{ celMatch }}',
data__messageBus = '{{ messageBus }}',
data__destination = '{{ destination }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND enrollmentsId = '{{ enrollmentsId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a single Enrollment.

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