Google Cloud Ai Platform V1 Client - Class CreateEndpointRequest (1.13.1)

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

Request message for EndpointService.CreateEndpoint.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
`↳ endpoint`	`Endpoint` Required. The Endpoint to create.
`↳ endpoint_id`	`string` Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.

getParent

Required. The resource name of the Location to create the Endpoint in.

Format: projects/{project}/locations/{location}

Returns
Type	Description
`string`

setParent

Required. The resource name of the Location to create the Endpoint in.

Format: projects/{project}/locations/{location}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEndpoint

Required. The Endpoint to create.

Returns
Type	Description
`Endpoint\|null`

hasEndpoint

clearEndpoint

setEndpoint

Required. The Endpoint to create.

Parameter
Name	Description
`var`	`Endpoint`

Returns
Type	Description
`$this`

getEndpointId

Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name.

If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are [a-z0-9-]. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are [0-9] with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as ?endpoint_id=12345. This is the fallback for fields that are not included in either the URI or the body.

Returns
Type	Description
`string`

setEndpointId

Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}` Please see EndpointServiceClient::locationName() for help formatting this field.
`endpoint`	`Endpoint` Required. The Endpoint to create.

Returns
Type	Description
`CreateEndpointRequest`

static::buildFromParentEndpointEndpointId

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}` Please see EndpointServiceClient::locationName() for help formatting this field.
`endpoint`	`Endpoint` Required. The Endpoint to create.
`endpointId`	`string` Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.

Returns
Type	Description
`CreateEndpointRequest`