Google Cloud Ids V1 Client - Class CreateEndpointRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Ids V1 Client class CreateEndpointRequest.

Generated from protobuf message google.cloud.ids.v1.CreateEndpointRequest

Methods

build

Parameters
NameDescription
parent string

Required. The endpoint's parent. Please see {@see \Google\Cloud\Ids\V1\IDSClient::locationName()} for help formatting this field.

endpoint Google\Cloud\Ids\V1\Endpoint

Required. The endpoint to create.

endpointId string

Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Returns
TypeDescription
Google\Cloud\Ids\V1\CreateEndpointRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The endpoint's parent.

↳ endpoint_id string

Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

↳ endpoint Google\Cloud\Ids\V1\Endpoint

Required. The endpoint to create.

↳ request_id string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getParent

Required. The endpoint's parent.

Returns
TypeDescription
string

setParent

Required. The endpoint's parent.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEndpointId

Required. The endpoint identifier. This will be part of the endpoint's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Returns
TypeDescription
string

setEndpointId

Required. The endpoint identifier. This will be part of the endpoint's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEndpoint

Required. The endpoint to create.

Returns
TypeDescription
Google\Cloud\Ids\V1\Endpoint|null

hasEndpoint

clearEndpoint

setEndpoint

Required. The endpoint to create.

Parameter
NameDescription
var Google\Cloud\Ids\V1\Endpoint
Returns
TypeDescription
$this

getRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
TypeDescription
string

setRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
NameDescription
var string
Returns
TypeDescription
$this