Class: Google::Cloud::AIPlatform::V1::Context

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

Overview

Instance of a general context.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this Context was created.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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 Description of the Context.

Returns:

  • (::String)

    Description of the Context



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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 User provided display name of the Context. May be up to 128 Unicode characters.

Returns:

  • (::String)

    User provided display name of the Context. May be up to 128 Unicode characters.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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 An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String)

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



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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 Contexts.

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. No more than 64 user labels can be associated with one Context (System labels are excluded).

Returns:

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

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

    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. No more than 64 user labels can be associated with one Context (System labels are excluded).



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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

#metadata::Google::Protobuf::Struct

Returns Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.

Returns:

  • (::Google::Protobuf::Struct)

    Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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

Returns Immutable. The resource name of the Context.

Returns:

  • (::String)

    Immutable. The resource name of the Context.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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

#parent_contexts::Array<::String> (readonly)

Returns Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.

Returns:

  • (::Array<::String>)

    Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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

#schema_title::String

Returns The title of the schema describing the metadata.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

Returns:

  • (::String)

    The title of the schema describing the metadata.

    Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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

#schema_version::String

Returns The version of the schema in schema_name to use.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

Returns:

  • (::String)

    The version of the schema in schema_name to use.

    Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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 Context was last updated.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'proto_docs/google/cloud/aiplatform/v1/context.rb', line 77

class Context
  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