Class PublisherModel.CallToAction.Deploy (3.47.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

Implements

PublisherModel.CallToAction.DeployOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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_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

AbstractMessage.equals(Object other)

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`

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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.

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`