public static final class CreateIndexRequest.Builder extends GeneratedMessage.Builder<CreateIndexRequest.Builder> implements CreateIndexRequestOrBuilderMessage for creating an Index.
Protobuf type google.cloud.visionai.v1.CreateIndexRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CreateIndexRequest.BuilderImplements
CreateIndexRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public CreateIndexRequest build()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
buildPartial()
public CreateIndexRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
clear()
public CreateIndexRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
clearIndex()
public CreateIndexRequest.Builder clearIndex()Required. The index being created.
.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
clearIndexId()
public CreateIndexRequest.Builder clearIndexId()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 |
CreateIndexRequest.Builder |
This builder for chaining. |
clearParent()
public CreateIndexRequest.Builder clearParent() 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 |
CreateIndexRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public CreateIndexRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getIndexBuilder()
public Index.Builder getIndexBuilder()Required. The index being created.
.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Index.Builder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CreateIndexRequest other)
public CreateIndexRequest.Builder mergeFrom(CreateIndexRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CreateIndexRequest |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreateIndexRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
mergeIndex(Index value)
public CreateIndexRequest.Builder mergeIndex(Index value)Required. The index being created.
.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setIndex(Index value)
public CreateIndexRequest.Builder setIndex(Index value)Required. The index being created.
.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Index |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setIndex(Index.Builder builderForValue)
public CreateIndexRequest.Builder setIndex(Index.Builder builderForValue)Required. The index being created.
.google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Index.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
|
setIndexId(String value)
public CreateIndexRequest.Builder setIndexId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe indexId to set. |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
This builder for chaining. |
setIndexIdBytes(ByteString value)
public CreateIndexRequest.Builder setIndexIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for indexId to set. |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
This builder for chaining. |
setParent(String value)
public CreateIndexRequest.Builder setParent(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateIndexRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateIndexRequest.Builder |
This builder for chaining. |