Class: Google::Cloud::AIPlatform::V1::IndexEndpoint

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

Overview

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this IndexEndpoint was created.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#deployed_indexes ⇒ ::Array<::Google::Cloud::AIPlatform::V1::DeployedIndex> (readonly)

Returns Output only. The indexes deployed in this endpoint.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#description ⇒ ::String

Returns The description of the IndexEndpoint.

Returns:

  • (::String) —

    The description of the IndexEndpoint.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#display_name ⇒ ::String

Returns Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#enable_private_service_connect ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.

Only one of the fields, network or enable_private_service_connect, can be set.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#etag ⇒ ::String

Returns Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

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

Returns The labels with user-defined metadata to organize your IndexEndpoints.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

Returns:

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

    The labels with user-defined metadata to organize your IndexEndpoints.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

    See https://goo.gl/xmQnxf for more information and examples of labels.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the IndexEndpoint.

Returns:

  • (::String) —

    Output only. The resource name of the IndexEndpoint.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#network ⇒ ::String

Returns Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.

Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.

network and private_service_connect_config are mutually exclusive.

Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in '12345', and {network} is network name.

Returns:

  • (::String) —

    Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.

    Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.

    network and private_service_connect_config are mutually exclusive.

    Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in '12345', and {network} is network name.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#private_service_connect_config ⇒ ::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig

Returns Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#public_endpoint_domain_name ⇒ ::String (readonly)

Returns Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.

Returns:

  • (::String) —

    Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#public_endpoint_enabled ⇒ ::Boolean

Returns Optional. If true, the deployed index will be accessible through public endpoint.

Returns:

  • (::Boolean) —

    Optional. If true, the deployed index will be accessible through public endpoint.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end

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

Returns Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb', line 117

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
end