com.google.cloud.aiplatform.v1

Class DeployRequest.EndpointConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<DeployRequest.EndpointConfig.Builder>

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

All Implemented Interfaces:

DeployRequest.EndpointConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

DeployRequest.EndpointConfig

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

 The endpoint config to use for the deployment.
 

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

Method Summary

Modifier and Type	Method and Description
DeployRequest.EndpointConfig	build()
DeployRequest.EndpointConfig	buildPartial()
DeployRequest.EndpointConfig.Builder	clear()
DeployRequest.EndpointConfig.Builder	clearDedicatedEndpointDisabled() Optional.
DeployRequest.EndpointConfig.Builder	clearDedicatedEndpointEnabled() Deprecated. google.cloud.aiplatform.v1.DeployRequest.EndpointConfig.dedicated_endpoint_enabled is deprecated. See google/cloud/aiplatform/v1/model_garden_service.proto;l=159
DeployRequest.EndpointConfig.Builder	clearEndpointDisplayName() Optional.
DeployRequest.EndpointConfig.Builder	clearEndpointUserId() Optional.
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
DeployRequest.EndpointConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getEndpointDisplayName() Optional.
com.google.protobuf.ByteString	getEndpointDisplayNameBytes() Optional.
String	getEndpointUserId() Optional.
com.google.protobuf.ByteString	getEndpointUserIdBytes() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
DeployRequest.EndpointConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
DeployRequest.EndpointConfig.Builder	mergeFrom(DeployRequest.EndpointConfig other)
DeployRequest.EndpointConfig.Builder	mergeFrom(com.google.protobuf.Message other)
DeployRequest.EndpointConfig.Builder	setDedicatedEndpointDisabled(boolean value) Optional.
DeployRequest.EndpointConfig.Builder	setDedicatedEndpointEnabled(boolean value) Deprecated. google.cloud.aiplatform.v1.DeployRequest.EndpointConfig.dedicated_endpoint_enabled is deprecated. See google/cloud/aiplatform/v1/model_garden_service.proto;l=159
DeployRequest.EndpointConfig.Builder	setEndpointDisplayName(String value) Optional.
DeployRequest.EndpointConfig.Builder	setEndpointDisplayNameBytes(com.google.protobuf.ByteString value) Optional.
DeployRequest.EndpointConfig.Builder	setEndpointUserId(String value) Optional.
DeployRequest.EndpointConfig.Builder	setEndpointUserIdBytes(com.google.protobuf.ByteString value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

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.Builder<DeployRequest.EndpointConfig.Builder>

clear

public DeployRequest.EndpointConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.EndpointConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.EndpointConfig.Builder>

getDefaultInstanceForType

public DeployRequest.EndpointConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public DeployRequest.EndpointConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public DeployRequest.EndpointConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public DeployRequest.EndpointConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployRequest.EndpointConfig.Builder>

mergeFrom

public DeployRequest.EndpointConfig.Builder mergeFrom(DeployRequest.EndpointConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.EndpointConfig.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployRequest.EndpointConfig.Builder>

Throws:

IOException

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.

setEndpointDisplayName

public DeployRequest.EndpointConfig.Builder setEndpointDisplayName(String value)

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

Parameters:

value - The endpointDisplayName to set.

Returns:

This builder for chaining.

clearEndpointDisplayName

public DeployRequest.EndpointConfig.Builder clearEndpointDisplayName()

 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:

This builder for chaining.

setEndpointDisplayNameBytes

public DeployRequest.EndpointConfig.Builder setEndpointDisplayNameBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for endpointDisplayName to set.

Returns:

This builder for chaining.

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.

setDedicatedEndpointEnabled

@Deprecated
public DeployRequest.EndpointConfig.Builder setDedicatedEndpointEnabled(boolean value)

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

Parameters:

value - The dedicatedEndpointEnabled to set.

Returns:

This builder for chaining.

clearDedicatedEndpointEnabled

@Deprecated
public DeployRequest.EndpointConfig.Builder clearDedicatedEndpointEnabled()

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:

This builder for chaining.

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.

setDedicatedEndpointDisabled

public DeployRequest.EndpointConfig.Builder setDedicatedEndpointDisabled(boolean value)

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

Parameters:

value - The dedicatedEndpointDisabled to set.

Returns:

This builder for chaining.

clearDedicatedEndpointDisabled

public DeployRequest.EndpointConfig.Builder clearDedicatedEndpointDisabled()

 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:

This builder for chaining.

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.

setEndpointUserId

public DeployRequest.EndpointConfig.Builder setEndpointUserId(String value)

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

Parameters:

value - The endpointUserId to set.

Returns:

This builder for chaining.

clearEndpointUserId

public DeployRequest.EndpointConfig.Builder clearEndpointUserId()

 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:

This builder for chaining.

setEndpointUserIdBytes

public DeployRequest.EndpointConfig.Builder setEndpointUserIdBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for endpointUserId to set.

Returns:

This builder for chaining.