Google Cloud Ai Platform V1 Client - Class DeploymentResourcePool (1.12.0)

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

A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Immutable. The resource name of the DeploymentResourcePool. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
↳ dedicated_resources DedicatedResources

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.
↳ encryption_spec EncryptionSpec

Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec.
↳ service_account string

The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.
↳ disable_container_logging bool

If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.
↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this DeploymentResourcePool was created.
↳ satisfies_pzs bool

Output only. Reserved for future use.
↳ satisfies_pzi bool

Output only. Reserved for future use.

getName

Immutable. The resource name of the DeploymentResourcePool.

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

Returns
Type Description
string

setName

Immutable. The resource name of the DeploymentResourcePool.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDedicatedResources

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.

Returns
Type Description
DedicatedResources|null

hasDedicatedResources

clearDedicatedResources

setDedicatedResources

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.

Parameter
Name Description
var DedicatedResources
Returns
Type Description
$this

getEncryptionSpec

Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec.

Returns
Type Description
EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec.

Parameter
Name Description
var EncryptionSpec
Returns
Type Description
$this

getServiceAccount

The service account that the DeploymentResourcePool's container(s) run as.

Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.

Returns
Type Description
string

setServiceAccount

The service account that the DeploymentResourcePool's container(s) run as.

Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisableContainerLogging

If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default.

Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.

Returns
Type Description
bool

setDisableContainerLogging

If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default.

Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this DeploymentResourcePool was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this DeploymentResourcePool was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type Description
bool

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this