Class CreateIndexRequest (0.4.0) 

public final class CreateIndexRequest extends GeneratedMessageV3 implements CreateIndexRequestOrBuilder

Message for creating an Index.

Protobuf type google.cloud.visionai.v1.CreateIndexRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateIndexRequest

Static Fields

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

INDEX_ID_FIELD_NUMBER

public static final int INDEX_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateIndexRequest getDefaultInstance()
Returns
Type Description
CreateIndexRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateIndexRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateIndexRequest getDefaultInstanceForType()
Returns
Type Description
CreateIndexRequest

getIndex()

public Index getIndex()

Required. The index being created.

.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index

The index.

getIndexId()

public String getIndexId()

Optional. The ID for the index. This will become the final resource name for the index. If the user does not specify this value, it will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The indexId.

getIndexIdBytes()

public ByteString getIndexIdBytes()

Optional. The ID for the index. This will become the final resource name for the index. If the user does not specify this value, it will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string index_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for indexId.

getIndexOrBuilder()

public IndexOrBuilder getIndexOrBuilder()

Required. The index being created.

.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IndexOrBuilder

getParent()

public String getParent()

Required. Value for the parent. The resource name of the Corpus under which this index is created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Value for the parent. The resource name of the Corpus under which this index is created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIndex()

public boolean hasIndex()

Required. The index being created.

.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the index 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 CreateIndexRequest.Builder newBuilderForType()
Returns
Type Description
CreateIndexRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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