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.
Parameters | |
---|---|
Name | Description |
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 |
Google\Protobuf\Timestamp
Output only. The creation time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last-modified time. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Resource labels. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. Resource 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}
Returns | |
---|---|
Type | Description |
string |
setName
Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. The creation time.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. The last-modified time.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last-modified time.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Optional. Resource labels.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Optional. Resource labels.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getAnnotations
Optional. Resource annotations.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setAnnotations
Optional. Resource annotations.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
Optional. Resource display name.
Returns | |
---|---|
Type | Description |
string |
setDisplayName
Optional. Resource display name.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCelMatch
Required. A CEL expression identifying which messages this enrollment applies to.
Returns | |
---|---|
Type | Description |
string |
setCelMatch
Required. A CEL expression identifying which messages this enrollment applies to.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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}.
Returns | |
---|---|
Type | Description |
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}.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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)"
Returns | |
---|---|
Type | Description |
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)"
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |