Class: Google::Cloud::VisionAI::V1::Index

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The create timestamp.

Returns:



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#deployed_indexes ⇒ ::Array<::Google::Cloud::VisionAI::V1::DeployedIndexReference> (readonly)

Returns Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

Returns:



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#description ⇒ ::String

Returns Optional. Optional description of the index.

Returns:

  • (::String) —

    Optional. Optional description of the index.



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#display_name ⇒ ::String

Returns Optional. Optional user-specified display name of the index.

Returns:

  • (::String) —

    Optional. Optional user-specified display name of the index.



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#entire_corpus ⇒ ::Boolean

Returns Include all assets under the corpus.

Returns:

  • (::Boolean) —

    Include all assets under the corpus.



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}.

Returns:

  • (::String) —

    Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't.

Returns:

  • (::Boolean) —

    Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't.



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't.

Returns:

  • (::Boolean) —

    Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't.



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#state ⇒ ::Google::Cloud::VisionAI::V1::Index::State (readonly)

Returns Output only. State of the index.

Returns:



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The update timestamp.

Returns:



909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 909

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum representing the different states through which an Index might cycle
  # during its lifetime.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3
  end
end