Google Cloud Eventarc V1 Client - Class CreateEnrollmentRequest (2.1.5)

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class CreateEnrollmentRequest.

The request message for the CreateEnrollment method.

Generated from protobuf message google.cloud.eventarc.v1.CreateEnrollmentRequest

Namespace

Google \ Cloud \ Eventarc \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent collection in which to add this enrollment.

↳ enrollment
Enrollment

Required. The enrollment to create.

↳ enrollment_id
string

Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^ a-z ?$).

↳ validate_only
bool

Optional. If set, validate the request and preview the review, but do not post it.

getParent

Required. The parent collection in which to add this enrollment.

Returns
Type
Description
string

setParent

Required. The parent collection in which to add this enrollment.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEnrollment

Required. The enrollment to create.

Returns
Type
Description
Enrollment |null

hasEnrollment

clearEnrollment

setEnrollment

Required. The enrollment to create.

Parameter
Name
Description
Returns
Type
Description
$this

getEnrollmentId

Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^ a-z ?$).

Returns
Type
Description
string

setEnrollmentId

Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^ a-z ?$).

Parameter
Name
Description
var
string
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
parent
string

Required. The parent collection in which to add this enrollment. Please see EventarcClient::locationName() for help formatting this field.

enrollment
Enrollment

Required. The enrollment to create.

enrollmentId
string

Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^ a-z ?$).

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: