Reference documentation and code samples for the Google Cloud Eventarc V1 Client class Enrollment.
An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
Generated from protobuf message google.cloud.eventarc.v1.Enrollment
Namespace
Google \ Cloud \ Eventarc \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
↳ 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.
↳ 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.
↳ create_time
↳ update_time
↳ labels
↳ annotations
↳ display_name
string
Optional. Resource display name.
↳ cel_match
string
Required. A CEL expression identifying which messages this enrollment applies to.
↳ message_bus
string
Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
↳ 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)"
getName
Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
string
setName
Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
var
string
$this
getUid
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.
string
setUid
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.
var
string
$this
getEtag
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.
string
setEtag
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.
var
string
$this
getCreateTime
Output only. The creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
$this
getUpdateTime
Output only. The last-modified time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last-modified time.
$this
getLabels
Optional. Resource labels.
setLabels
Optional. Resource labels.
$this
getAnnotations
Optional. Resource annotations.
setAnnotations
Optional. Resource annotations.
$this
getDisplayName
Optional. Resource display name.
string
setDisplayName
Optional. Resource display name.
var
string
$this
getCelMatch
Required. A CEL expression identifying which messages this enrollment applies to.
string
setCelMatch
Required. A CEL expression identifying which messages this enrollment applies to.
var
string
$this
getMessageBus
Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
string
setMessageBus
Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
var
string
$this
getDestination
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)"
string
setDestination
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)"
var
string
$this
