Reference documentation and code samples for the Google Cloud Eventarc V1 Client class UpdateEnrollmentRequest.
The request message for the UpdateEnrollment method.
Generated from protobuf message google.cloud.eventarc.v1.UpdateEnrollmentRequest
Namespace
Google \ Cloud \ Eventarc \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enrollment |
Enrollment
Required. The Enrollment to be updated. |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
↳ allow_missing |
bool
Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation, |
↳ validate_only |
bool
Optional. If set, validate the request and preview the review, but do not post it. |
getEnrollment
Required. The Enrollment to be updated.
Returns | |
---|---|
Type | Description |
Enrollment|null |
hasEnrollment
clearEnrollment
setEnrollment
Required. The Enrollment to be updated.
Parameter | |
---|---|
Name | Description |
var |
Enrollment
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateMask
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getAllowMissing
Optional. If set to true, and the Enrollment is not found, a new Enrollment
will be created. In this situation, update_mask
is ignored.
Returns | |
---|---|
Type | Description |
bool |
setAllowMissing
Optional. If set to true, and the Enrollment is not found, a new Enrollment
will be created. In this situation, update_mask
is ignored.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getValidateOnly
Optional. If set, validate the request and preview the review, but do not post it.
Returns | |
---|---|
Type | Description |
bool |
setValidateOnly
Optional. If set, validate the request and preview the review, but do not post it.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
enrollment |
Enrollment
Required. The Enrollment to be updated. |
updateMask |
Google\Protobuf\FieldMask
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
Returns | |
---|---|
Type | Description |
UpdateEnrollmentRequest |