Class DeployRequest.EndpointConfig (3.74.0)

public static final class DeployRequest.EndpointConfig extends GeneratedMessageV3 implements DeployRequest.EndpointConfigOrBuilder

The endpoint config to use for the deployment.

Protobuf type google.cloud.aiplatform.v1.DeployRequest.EndpointConfig

Static Fields

DEDICATED_ENDPOINT_DISABLED_FIELD_NUMBER

public static final int DEDICATED_ENDPOINT_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_ENDPOINT_ENABLED_FIELD_NUMBER

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

ENDPOINT_USER_ID_FIELD_NUMBER

public static final int ENDPOINT_USER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployRequest.EndpointConfig getDefaultInstance()
Returns
Type Description
DeployRequest.EndpointConfig

getDescriptor()

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

newBuilder()

public static DeployRequest.EndpointConfig.Builder newBuilder()
Returns
Type Description
DeployRequest.EndpointConfig.Builder

newBuilder(DeployRequest.EndpointConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static DeployRequest.EndpointConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployRequest.EndpointConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static DeployRequest.EndpointConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeployRequest.EndpointConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static DeployRequest.EndpointConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeployRequest.EndpointConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static DeployRequest.EndpointConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployRequest.EndpointConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static DeployRequest.EndpointConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeployRequest.EndpointConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DeployRequest.EndpointConfig> parser()
Returns
Type Description
Parser<EndpointConfig>

Methods

equals(Object obj)

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

getDedicatedEndpointDisabled()

public boolean getDedicatedEndpointDisabled()

Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.

If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.

bool dedicated_endpoint_disabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dedicatedEndpointDisabled.

getDedicatedEndpointEnabled() (deprecated)

public boolean getDedicatedEndpointEnabled()

Deprecated. google.cloud.aiplatform.v1.DeployRequest.EndpointConfig.dedicated_endpoint_enabled is deprecated. See google/cloud/aiplatform/v1/model_garden_service.proto;l=159

Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.

bool dedicated_endpoint_enabled = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dedicatedEndpointEnabled.

getDefaultInstanceForType()

public DeployRequest.EndpointConfig getDefaultInstanceForType()
Returns
Type Description
DeployRequest.EndpointConfig

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 = 1 [(.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 = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointDisplayName.

getEndpointUserId()

public String getEndpointUserId()

Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID.

If the first character is a letter, this value may be up to 63 characters, and valid characters are [a-z0-9-]. The last character must be a letter or number.

If the first character is a number, this value may be up to 9 characters, and valid characters are [0-9] with no leading zeros.

When using HTTP/JSON, this field is populated based on a query string argument, such as ?endpoint_id=12345. This is the fallback for fields that are not included in either the URI or the body.

string endpoint_user_id = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The endpointUserId.

getEndpointUserIdBytes()

public ByteString getEndpointUserIdBytes()

Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID.

If the first character is a letter, this value may be up to 63 characters, and valid characters are [a-z0-9-]. The last character must be a letter or number.

If the first character is a number, this value may be up to 9 characters, and valid characters are [0-9] with no leading zeros.

When using HTTP/JSON, this field is populated based on a query string argument, such as ?endpoint_id=12345. This is the fallback for fields that are not included in either the URI or the body.

string endpoint_user_id = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointUserId.

getParserForType()

public Parser<DeployRequest.EndpointConfig> getParserForType()
Returns
Type Description
Parser<EndpointConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 DeployRequest.EndpointConfig.Builder newBuilderForType()
Returns
Type Description
DeployRequest.EndpointConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DeployRequest.EndpointConfig.Builder toBuilder()
Returns
Type Description
DeployRequest.EndpointConfig.Builder

writeTo(CodedOutputStream output)

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