Class DeployIndexRequest (3.8.0)

public final class DeployIndexRequest extends GeneratedMessageV3 implements DeployIndexRequestOrBuilder

Request message for IndexEndpointService.DeployIndex.

Protobuf type google.cloud.aiplatform.v1beta1.DeployIndexRequest

Static Fields

DEPLOYED_INDEX_FIELD_NUMBER

public static final int DEPLOYED_INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DeployIndexRequest getDefaultInstance()
Returns
TypeDescription
DeployIndexRequest

getDescriptor()

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

newBuilder()

public static DeployIndexRequest.Builder newBuilder()
Returns
TypeDescription
DeployIndexRequest.Builder

newBuilder(DeployIndexRequest prototype)

public static DeployIndexRequest.Builder newBuilder(DeployIndexRequest prototype)
Parameter
NameDescription
prototypeDeployIndexRequest
Returns
TypeDescription
DeployIndexRequest.Builder

parseDelimitedFrom(InputStream input)

public static DeployIndexRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DeployIndexRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeployIndexRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeployIndexRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DeployIndexRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DeployIndexRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeployIndexRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployIndexRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DeployIndexRequest> parser()
Returns
TypeDescription
Parser<DeployIndexRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DeployIndexRequest getDefaultInstanceForType()
Returns
TypeDescription
DeployIndexRequest

getDeployedIndex()

public DeployedIndex getDeployedIndex()

Required. The DeployedIndex to be created within the IndexEndpoint.

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

Returns
TypeDescription
DeployedIndex

The deployedIndex.

getDeployedIndexOrBuilder()

public DeployedIndexOrBuilder getDeployedIndexOrBuilder()

Required. The DeployedIndex to be created within the IndexEndpoint.

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

Returns
TypeDescription
DeployedIndexOrBuilder

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.

getParserForType()

public Parser<DeployIndexRequest> getParserForType()
Returns
TypeDescription
Parser<DeployIndexRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDeployedIndex()

public boolean hasDeployedIndex()

Required. The DeployedIndex to be created within the IndexEndpoint.

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

Returns
TypeDescription
boolean

Whether the deployedIndex field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DeployIndexRequest.Builder newBuilderForType()
Returns
TypeDescription
DeployIndexRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeployIndexRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DeployIndexRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DeployIndexRequest.Builder toBuilder()
Returns
TypeDescription
DeployIndexRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException