Class: Google::Cloud::VisionAI::V1::IndexEndpoint

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

Overview

Message representing IndexEndpoint resource. Indexes are deployed into it.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Create timestamp.

Returns:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

#deployed_index ⇒ ::Google::Cloud::VisionAI::V1::DeployedIndex (readonly)

Returns Output only. The Index deployed in this IndexEndpoint.

Returns:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

#description ⇒ ::String

Returns Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.

Returns:

  • (::String) —

    Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

#display_name ⇒ ::String

Returns Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.

Returns:

  • (::String) —

    Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}.

Returns:

  • (::String) —

    Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  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 endpoint is a valid zone isolated index endpoint 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 endpoint is a valid zone isolated index endpoint and false if it isn't.



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  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 endpoint is a valid zone separated index endpoint 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 endpoint is a valid zone separated index endpoint and false if it isn't.



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

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

Returns Output only. IndexEndpoint state.

Returns:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end

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

Returns Output only. Update timestamp.

Returns:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1946

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # IndexEndpoint stage.
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State UPDATING.
    UPDATING = 3

    # State FAILED.
    FAILED = 4
  end
end