Class DeploymentResourcePool (3.55.0)

public final class DeploymentResourcePool extends GeneratedMessageV3 implements DeploymentResourcePoolOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.DeploymentResourcePool

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_CONTAINER_LOGGING_FIELD_NUMBER

public static final int DISABLE_CONTAINER_LOGGING_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeploymentResourcePool getDefaultInstance()
Returns
Type Description
DeploymentResourcePool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DeploymentResourcePool.Builder newBuilder()
Returns
Type Description
DeploymentResourcePool.Builder

newBuilder(DeploymentResourcePool prototype)

public static DeploymentResourcePool.Builder newBuilder(DeploymentResourcePool prototype)
Parameter
Name Description
prototype DeploymentResourcePool
Returns
Type Description
DeploymentResourcePool.Builder

parseDelimitedFrom(InputStream input)

public static DeploymentResourcePool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeploymentResourcePool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeploymentResourcePool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeploymentResourcePool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeploymentResourcePool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeploymentResourcePool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeploymentResourcePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentResourcePool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeploymentResourcePool> parser()
Returns
Type Description
Parser<DeploymentResourcePool>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this DeploymentResourcePool was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this DeploymentResourcePool was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDedicatedResources()

public DedicatedResources getDedicatedResources()

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DedicatedResources

The dedicatedResources.

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public DeploymentResourcePool getDefaultInstanceForType()
Returns
Type Description
DeploymentResourcePool

getDisableContainerLogging()

public boolean 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.

bool disable_container_logging = 7;

Returns
Type Description
boolean

The disableContainerLogging.

getEncryptionSpec()

public EncryptionSpec 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.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 5;

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

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.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 5;

Returns
Type Description
EncryptionSpecOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DeploymentResourcePool> getParserForType()
Returns
Type Description
Parser<DeploymentResourcePool>
Overrides

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String 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.

string service_account = 6;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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.

string service_account = 6;

Returns
Type Description
ByteString

The bytes for serviceAccount.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this DeploymentResourcePool was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDedicatedResources()

public boolean hasDedicatedResources()

Required. The underlying DedicatedResources that the DeploymentResourcePool uses.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the dedicatedResources field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

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.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 5;

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeploymentResourcePool.Builder newBuilderForType()
Returns
Type Description
DeploymentResourcePool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeploymentResourcePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeploymentResourcePool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DeploymentResourcePool.Builder toBuilder()
Returns
Type Description
DeploymentResourcePool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException