Google Cloud Ai Platform V1 Client - Class CreateContextRequest (0.16.0)

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

Request message for MetadataService.CreateContext.

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

Methods

build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` Please see {@see \Google\Cloud\AIPlatform\V1\MetadataServiceClient::metadataStoreName()} for help formatting this field.
`context`	`Google\Cloud\AIPlatform\V1\Context` Required. The Context to create.
`contextId`	`string` The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\CreateContextRequest`

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`↳ context`	`Google\Cloud\AIPlatform\V1\Context` Required. The Context to create.
`↳ context_id`	`string` The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)

getParent

Required. The resource name of the MetadataStore where the Context should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Returns
Type	Description
`string`

setParent

Required. The resource name of the MetadataStore where the Context should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContext

Required. The Context to create.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\Context\|null`

hasContext

clearContext

setContext

Required. The Context to create.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\Context`

Returns
Type	Description
`$this`

getContextId

The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}.

If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)

Returns
Type	Description
`string`

setContextId

The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`