Class DeployPublisherModelRequest (3.57.0)

public final class DeployPublisherModelRequest extends GeneratedMessageV3 implements DeployPublisherModelRequestOrBuilder

Request message for ModelGardenService.DeployPublisherModel.

Protobuf type google.cloud.aiplatform.v1beta1.DeployPublisherModelRequest

Static Fields

ACCEPT_EULA_FIELD_NUMBER

public static final int ACCEPT_EULA_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_DISPLAY_NAME_FIELD_NUMBER

public static final int ENDPOINT_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HUGGING_FACE_ACCESS_TOKEN_FIELD_NUMBER

public static final int HUGGING_FACE_ACCESS_TOKEN_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

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployPublisherModelRequest getDefaultInstance()
Returns
Type Description
DeployPublisherModelRequest

getDescriptor()

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

newBuilder()

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

newBuilder(DeployPublisherModelRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAcceptEula()

public boolean getAcceptEula()

Optional. Whether the user accepts the End User License Agreement (EULA) for the model.

bool accept_eula = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The acceptEula.

getDedicatedResources()

public DedicatedResources getDedicatedResources()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DedicatedResources

The dedicatedResources.

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public DeployPublisherModelRequest getDefaultInstanceForType()
Returns
Type Description
DeployPublisherModelRequest

getDestination()

public String getDestination()

Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The destination.

getDestinationBytes()

public ByteString getDestinationBytes()

Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for destination.

getEndpointDisplayName()

public String getEndpointDisplayName()

Optional. The user-specified display name of the endpoint. If not set, a default name will be used.

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The endpointDisplayName.

getEndpointDisplayNameBytes()

public ByteString getEndpointDisplayNameBytes()

Optional. The user-specified display name of the endpoint. If not set, a default name will be used.

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointDisplayName.

getHuggingFaceAccessToken()

public String getHuggingFaceAccessToken()

Optional. The Hugging Face read access token used to access the model artifacts of gated models.

string hugging_face_access_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The huggingFaceAccessToken.

getHuggingFaceAccessTokenBytes()

public ByteString getHuggingFaceAccessTokenBytes()

Optional. The Hugging Face read access token used to access the model artifacts of gated models.

string hugging_face_access_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for huggingFaceAccessToken.

getModel()

public String getModel()

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for model.

getModelDisplayName()

public String getModelDisplayName()

Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.

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

Returns
Type Description
String

The modelDisplayName.

getModelDisplayNameBytes()

public ByteString getModelDisplayNameBytes()

Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.

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

Returns
Type Description
ByteString

The bytes for modelDisplayName.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDedicatedResources()

public boolean hasDedicatedResources()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dedicatedResources 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 DeployPublisherModelRequest.Builder newBuilderForType()
Returns
Type Description
DeployPublisherModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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