Class DeployIndexRequest (3.53.0)

public final class DeployIndexRequest extends GeneratedMessageV3 implements DeployIndexRequestOrBuilder

Request message for IndexEndpointService.DeployIndex.

Protobuf type google.cloud.aiplatform.v1.DeployIndexRequest

Static Fields

DEPLOYED_INDEX_FIELD_NUMBER

public static final int DEPLOYED_INDEX_FIELD_NUMBER
Field Value
Type Description
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployIndexRequest getDefaultInstance()
Returns
Type Description
DeployIndexRequest

getDescriptor()

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

newBuilder()

public static DeployIndexRequest.Builder newBuilder()
Returns
Type Description
DeployIndexRequest.Builder

newBuilder(DeployIndexRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static DeployIndexRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployIndexRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static DeployIndexRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeployIndexRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static DeployIndexRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeployIndexRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static DeployIndexRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployIndexRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static DeployIndexRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeployIndexRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DeployIndexRequest> parser()
Returns
Type Description
Parser<DeployIndexRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DeployIndexRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
DeployedIndex

The deployedIndex.

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for indexEndpoint.

getParserForType()

public Parser<DeployIndexRequest> getParserForType()
Returns
Type Description
Parser<DeployIndexRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Type Description
boolean

Whether the deployedIndex field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DeployIndexRequest.Builder toBuilder()
Returns
Type Description
DeployIndexRequest.Builder

writeTo(CodedOutputStream output)

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