Class DeployIndexRequest.Builder (3.7.0)

public static final class DeployIndexRequest.Builder extends GeneratedMessageV3.Builder<DeployIndexRequest.Builder> implements DeployIndexRequestOrBuilder

Request message for IndexEndpointService.DeployIndex.

Protobuf type google.cloud.aiplatform.v1.DeployIndexRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployIndexRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

build()

public DeployIndexRequest build()
Returns
TypeDescription
DeployIndexRequest

buildPartial()

public DeployIndexRequest buildPartial()
Returns
TypeDescription
DeployIndexRequest

clear()

public DeployIndexRequest.Builder clear()
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

clearDeployedIndex()

public DeployIndexRequest.Builder clearDeployedIndex()

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DeployIndexRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public DeployIndexRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

clearIndexEndpoint()

public DeployIndexRequest.Builder clearIndexEndpoint()

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
DeployIndexRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployIndexRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

clone()

public DeployIndexRequest.Builder clone()
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

getDefaultInstanceForType()

public DeployIndexRequest getDefaultInstanceForType()
Returns
TypeDescription
DeployIndexRequest

getDeployedIndex()

public DeployedIndex getDeployedIndex()

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DeployedIndex

The deployedIndex.

getDeployedIndexBuilder()

public DeployedIndex.Builder getDeployedIndexBuilder()

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DeployedIndex.Builder

getDeployedIndexOrBuilder()

public DeployedIndexOrBuilder getDeployedIndexOrBuilder()

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DeployedIndexOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndexEndpoint()

public String getIndexEndpoint()

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The indexEndpoint.

getIndexEndpointBytes()

public ByteString getIndexEndpointBytes()

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for indexEndpoint.

hasDeployedIndex()

public boolean hasDeployedIndex()

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the deployedIndex field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDeployedIndex(DeployedIndex value)

public DeployIndexRequest.Builder mergeDeployedIndex(DeployedIndex value)

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueDeployedIndex
Returns
TypeDescription
DeployIndexRequest.Builder

mergeFrom(DeployIndexRequest other)

public DeployIndexRequest.Builder mergeFrom(DeployIndexRequest other)
Parameter
NameDescription
otherDeployIndexRequest
Returns
TypeDescription
DeployIndexRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DeployIndexRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployIndexRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

setDeployedIndex(DeployedIndex value)

public DeployIndexRequest.Builder setDeployedIndex(DeployedIndex value)

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueDeployedIndex
Returns
TypeDescription
DeployIndexRequest.Builder

setDeployedIndex(DeployedIndex.Builder builderForValue)

public DeployIndexRequest.Builder setDeployedIndex(DeployedIndex.Builder builderForValue)

Required. The DeployedIndex to be created within the IndexEndpoint.

.google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueDeployedIndex.Builder
Returns
TypeDescription
DeployIndexRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DeployIndexRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

setIndexEndpoint(String value)

public DeployIndexRequest.Builder setIndexEndpoint(String value)

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The indexEndpoint to set.

Returns
TypeDescription
DeployIndexRequest.Builder

This builder for chaining.

setIndexEndpointBytes(ByteString value)

public DeployIndexRequest.Builder setIndexEndpointBytes(ByteString value)

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for indexEndpoint to set.

Returns
TypeDescription
DeployIndexRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployIndexRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployIndexRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides