com.google.cloud.aiplatform.v1

Class DeployRequest.EndpointConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.DeployRequest.EndpointConfig

All Implemented Interfaces:

DeployRequest.EndpointConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DeployRequest

public static final class DeployRequest.EndpointConfig
extends com.google.protobuf.GeneratedMessage
implements DeployRequest.EndpointConfigOrBuilder

 The endpoint config to use for the deployment.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployRequest.EndpointConfig.Builder The endpoint config to use for the deployment.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEDICATED_ENDPOINT_DISABLED_FIELD_NUMBER
static int	DEDICATED_ENDPOINT_ENABLED_FIELD_NUMBER
static int	ENDPOINT_DISPLAY_NAME_FIELD_NUMBER
static int	ENDPOINT_USER_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getDedicatedEndpointDisabled() Optional.
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
static DeployRequest.EndpointConfig	getDefaultInstance()
DeployRequest.EndpointConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEndpointDisplayName() Optional.
com.google.protobuf.ByteString	getEndpointDisplayNameBytes() Optional.
String	getEndpointUserId() Optional.
com.google.protobuf.ByteString	getEndpointUserIdBytes() Optional.
com.google.protobuf.Parser<DeployRequest.EndpointConfig>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DeployRequest.EndpointConfig.Builder	newBuilder()
static DeployRequest.EndpointConfig.Builder	newBuilder(DeployRequest.EndpointConfig prototype)
DeployRequest.EndpointConfig.Builder	newBuilderForType()
protected DeployRequest.EndpointConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static DeployRequest.EndpointConfig	parseDelimitedFrom(InputStream input)
static DeployRequest.EndpointConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.EndpointConfig	parseFrom(byte[] data)
static DeployRequest.EndpointConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.EndpointConfig	parseFrom(ByteBuffer data)
static DeployRequest.EndpointConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.EndpointConfig	parseFrom(com.google.protobuf.ByteString data)
static DeployRequest.EndpointConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.EndpointConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static DeployRequest.EndpointConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.EndpointConfig	parseFrom(InputStream input)
static DeployRequest.EndpointConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DeployRequest.EndpointConfig>	parser()
DeployRequest.EndpointConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ENDPOINT_DISPLAY_NAME_FIELD_NUMBER

public static final int ENDPOINT_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DEDICATED_ENDPOINT_ENABLED_FIELD_NUMBER

public static final int DEDICATED_ENDPOINT_ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

DEDICATED_ENDPOINT_DISABLED_FIELD_NUMBER

public static final int DEDICATED_ENDPOINT_DISABLED_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINT_USER_ID_FIELD_NUMBER

public static final int ENDPOINT_USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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];

Specified by:

getEndpointDisplayName in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The endpointDisplayName.

getEndpointDisplayNameBytes

public com.google.protobuf.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];

Specified by:

getEndpointDisplayNameBytes in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The bytes for endpointDisplayName.

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];

Specified by:

getDedicatedEndpointEnabled in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The dedicatedEndpointEnabled.

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];

Specified by:

getDedicatedEndpointDisabled in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The dedicatedEndpointDisabled.

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];

Specified by:

getEndpointUserId in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The endpointUserId.

getEndpointUserIdBytes

public com.google.protobuf.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];

Specified by:

getEndpointUserIdBytes in interface DeployRequest.EndpointConfigOrBuilder

Returns:

The bytes for endpointUserId.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DeployRequest.EndpointConfig parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployRequest.EndpointConfig parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployRequest.EndpointConfig parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.EndpointConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public DeployRequest.EndpointConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DeployRequest.EndpointConfig.Builder newBuilder()

newBuilder

public static DeployRequest.EndpointConfig.Builder newBuilder(DeployRequest.EndpointConfig prototype)

toBuilder

public DeployRequest.EndpointConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DeployRequest.EndpointConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static DeployRequest.EndpointConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<DeployRequest.EndpointConfig> parser()

getParserForType

public com.google.protobuf.Parser<DeployRequest.EndpointConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public DeployRequest.EndpointConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder