Class PublisherModel.CallToAction.Deploy (3.48.0)

public static final class PublisherModel.CallToAction.Deploy extends GeneratedMessageV3 implements PublisherModel.CallToAction.DeployOrBuilder

Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.

Protobuf type google.cloud.aiplatform.v1.PublisherModel.CallToAction.Deploy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PublisherModel.CallToAction.Deploy

Static Fields

ARTIFACT_URI_FIELD_NUMBER

public static final int ARTIFACT_URI_FIELD_NUMBER
Field Value
Type Description
int

AUTOMATIC_RESOURCES_FIELD_NUMBER

public static final int AUTOMATIC_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

CONTAINER_SPEC_FIELD_NUMBER

public static final int CONTAINER_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

DEPLOY_METADATA_FIELD_NUMBER

public static final int DEPLOY_METADATA_FIELD_NUMBER
Field Value
Type Description
int

DEPLOY_TASK_NAME_FIELD_NUMBER

public static final int DEPLOY_TASK_NAME_FIELD_NUMBER
Field Value
Type Description
int

LARGE_MODEL_REFERENCE_FIELD_NUMBER

public static final int LARGE_MODEL_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

MODEL_DISPLAY_NAME_FIELD_NUMBER

public static final int MODEL_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_ARTIFACT_URI_FIELD_NUMBER

public static final int PUBLIC_ARTIFACT_URI_FIELD_NUMBER
Field Value
Type Description
int

SHARED_RESOURCES_FIELD_NUMBER

public static final int SHARED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PublisherModel.CallToAction.Deploy getDefaultInstance()
Returns
Type Description
PublisherModel.CallToAction.Deploy

getDescriptor()

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

newBuilder()

public static PublisherModel.CallToAction.Deploy.Builder newBuilder()
Returns
Type Description
PublisherModel.CallToAction.Deploy.Builder

newBuilder(PublisherModel.CallToAction.Deploy prototype)

public static PublisherModel.CallToAction.Deploy.Builder newBuilder(PublisherModel.CallToAction.Deploy prototype)
Parameter
Name Description
prototype PublisherModel.CallToAction.Deploy
Returns
Type Description
PublisherModel.CallToAction.Deploy.Builder

parseDelimitedFrom(InputStream input)

public static PublisherModel.CallToAction.Deploy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PublisherModel.CallToAction.Deploy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PublisherModel.CallToAction.Deploy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PublisherModel.CallToAction.Deploy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PublisherModel.CallToAction.Deploy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PublisherModel.CallToAction.Deploy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PublisherModel.CallToAction.Deploy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublisherModel.CallToAction.Deploy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PublisherModel.CallToAction.Deploy> parser()
Returns
Type Description
Parser<Deploy>

Methods

equals(Object obj)

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

getArtifactUri()

public String getArtifactUri()

Optional. The path to the directory containing the Model artifact and any of its supporting files.

string artifact_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The artifactUri.

getArtifactUriBytes()

public ByteString getArtifactUriBytes()

Optional. The path to the directory containing the Model artifact and any of its supporting files.

string artifact_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for artifactUri.

getAutomaticResources()

public AutomaticResources getAutomaticResources()

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 6;

Returns
Type Description
AutomaticResources

The automaticResources.

getAutomaticResourcesOrBuilder()

public AutomaticResourcesOrBuilder getAutomaticResourcesOrBuilder()

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 6;

Returns
Type Description
AutomaticResourcesOrBuilder

getContainerSpec()

public ModelContainerSpec getContainerSpec()

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelContainerSpec

The containerSpec.

getContainerSpecOrBuilder()

public ModelContainerSpecOrBuilder getContainerSpecOrBuilder()

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelContainerSpecOrBuilder

getDedicatedResources()

public DedicatedResources getDedicatedResources()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 5;

Returns
Type Description
DedicatedResources

The dedicatedResources.

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 5;

Returns
Type Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public PublisherModel.CallToAction.Deploy getDefaultInstanceForType()
Returns
Type Description
PublisherModel.CallToAction.Deploy

getDeployMetadata()

public PublisherModel.CallToAction.Deploy.DeployMetadata getDeployMetadata()

Optional. Metadata information about this deployment config.

optional .google.cloud.aiplatform.v1.PublisherModel.CallToAction.Deploy.DeployMetadata deploy_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublisherModel.CallToAction.Deploy.DeployMetadata

The deployMetadata.

getDeployMetadataOrBuilder()

public PublisherModel.CallToAction.Deploy.DeployMetadataOrBuilder getDeployMetadataOrBuilder()

Optional. Metadata information about this deployment config.

optional .google.cloud.aiplatform.v1.PublisherModel.CallToAction.Deploy.DeployMetadata deploy_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublisherModel.CallToAction.Deploy.DeployMetadataOrBuilder

getDeployTaskName()

public String getDeployTaskName()

Optional. The name of the deploy task (e.g., "text to image generation").

optional string deploy_task_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The deployTaskName.

getDeployTaskNameBytes()

public ByteString getDeployTaskNameBytes()

Optional. The name of the deploy task (e.g., "text to image generation").

optional string deploy_task_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for deployTaskName.

getLargeModelReference()

public LargeModelReference getLargeModelReference()

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

.google.cloud.aiplatform.v1.LargeModelReference large_model_reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LargeModelReference

The largeModelReference.

getLargeModelReferenceOrBuilder()

public LargeModelReferenceOrBuilder getLargeModelReferenceOrBuilder()

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

.google.cloud.aiplatform.v1.LargeModelReference large_model_reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LargeModelReferenceOrBuilder

getModelDisplayName()

public String getModelDisplayName()

Optional. Default model display name.

string model_display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The modelDisplayName.

getModelDisplayNameBytes()

public ByteString getModelDisplayNameBytes()

Optional. Default model display name.

string model_display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for modelDisplayName.

getParserForType()

public Parser<PublisherModel.CallToAction.Deploy> getParserForType()
Returns
Type Description
Parser<Deploy>
Overrides

getPredictionResourcesCase()

public PublisherModel.CallToAction.Deploy.PredictionResourcesCase getPredictionResourcesCase()
Returns
Type Description
PublisherModel.CallToAction.Deploy.PredictionResourcesCase

getPublicArtifactUri()

public String getPublicArtifactUri()

Optional. The signed URI for ephemeral Cloud Storage access to model artifact.

string public_artifact_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The publicArtifactUri.

getPublicArtifactUriBytes()

public ByteString getPublicArtifactUriBytes()

Optional. The signed URI for ephemeral Cloud Storage access to model artifact.

string public_artifact_uri = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for publicArtifactUri.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSharedResources()

public String getSharedResources()

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

string shared_resources = 7;

Returns
Type Description
String

The sharedResources.

getSharedResourcesBytes()

public ByteString getSharedResourcesBytes()

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

string shared_resources = 7;

Returns
Type Description
ByteString

The bytes for sharedResources.

getTitle()

public String getTitle()

Required. The title of the regional resource reference.

string title = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Required. The title of the regional resource reference.

string title = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for title.

hasAutomaticResources()

public boolean hasAutomaticResources()

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

.google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 6;

Returns
Type Description
boolean

Whether the automaticResources field is set.

hasContainerSpec()

public boolean hasContainerSpec()

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the containerSpec field is set.

hasDedicatedResources()

public boolean hasDedicatedResources()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 5;

Returns
Type Description
boolean

Whether the dedicatedResources field is set.

hasDeployMetadata()

public boolean hasDeployMetadata()

Optional. Metadata information about this deployment config.

optional .google.cloud.aiplatform.v1.PublisherModel.CallToAction.Deploy.DeployMetadata deploy_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the deployMetadata field is set.

hasDeployTaskName()

public boolean hasDeployTaskName()

Optional. The name of the deploy task (e.g., "text to image generation").

optional string deploy_task_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the deployTaskName field is set.

hasLargeModelReference()

public boolean hasLargeModelReference()

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

.google.cloud.aiplatform.v1.LargeModelReference large_model_reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the largeModelReference field is set.

hasSharedResources()

public boolean hasSharedResources()

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

string shared_resources = 7;

Returns
Type Description
boolean

Whether the sharedResources 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 PublisherModel.CallToAction.Deploy.Builder newBuilderForType()
Returns
Type Description
PublisherModel.CallToAction.Deploy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PublisherModel.CallToAction.Deploy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PublisherModel.CallToAction.Deploy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public PublisherModel.CallToAction.Deploy.Builder toBuilder()
Returns
Type Description
PublisherModel.CallToAction.Deploy.Builder

writeTo(CodedOutputStream output)

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