Interface CreateIndexRequestOrBuilder (0.12.0)

Version latest

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface CreateIndexRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIndex()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasIndex()

public abstract 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.