Vision AI V1 API - Class Google::Cloud::VisionAI::V1::CreateIndexRequest (v0.3.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::CreateIndexRequest.

Message for creating an Index.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#index

def index() -> ::Google::Cloud::VisionAI::V1::Index
Returns

#index=

def index=(value) -> ::Google::Cloud::VisionAI::V1::Index
Parameter
Returns

#index_id

def index_id() -> ::String
Returns
  • (::String) — 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.

#index_id=

def index_id=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — 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}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}
Returns
  • (::String) — 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}