Package com.google.cloud.visionai.v1

Interface CreateIndexRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateIndexRequest, CreateIndexRequest.Builder
@Generated public interface CreateIndexRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Index
    getIndex()
    Required.
    String
    getIndexId()
    Optional.
    com.google.protobuf.ByteString
    getIndexIdBytes()
    Optional.
    IndexOrBuilder
    getIndexOrBuilder()
    Required.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    boolean
    hasIndex()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • getIndexId

      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][0-9]-/. 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:
      The indexId.

    • getIndexIdBytes

      com.google.protobuf.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][0-9]-/. 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:
      The bytes for indexId.

    • hasIndex

      boolean hasIndex()
       Required. The index being created.
      .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the index field is set.

    • getIndex

      Index getIndex()
       Required. The index being created.
      .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The index.

    • getIndexOrBuilder

      IndexOrBuilder getIndexOrBuilder()
       Required. The index being created.
      .google.cloud.visionai.v1.Index index = 3 [(.google.api.field_behavior) = REQUIRED];