public final class Context extends GeneratedMessageV3 implements ContextOrBuilder
Instance of a general context.
Protobuf type google.cloud.aiplatform.v1.Context
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_CONTEXTS_FIELD_NUMBER
public static final int PARENT_CONTEXTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEMA_TITLE_FIELD_NUMBER
public static final int SCHEMA_TITLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEMA_VERSION_FIELD_NUMBER
public static final int SCHEMA_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Context getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Context.Builder newBuilder()
newBuilder(Context prototype)
public static Context.Builder newBuilder(Context prototype)
| Parameter |
|---|
| Name | Description |
prototype | Context
|
parseDelimitedFrom(InputStream input)
public static Context parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Context parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Context parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static Context parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static Context parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Context parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Context> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
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).
map<string, string> labels = 9;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Context getDefaultInstanceForType()
getDescription()
public String getDescription()
Description of the Context
string description = 16;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Description of the Context
string description = 16;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
User provided display name of the Context.
May be up to 128 Unicode characters.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
User provided display name of the Context.
May be up to 128 Unicode characters.
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getEtag()
An eTag used to perform consistent read-modify-write updates. If not set, a
blind "overwrite" update happens.
string etag = 8;
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
An eTag used to perform consistent read-modify-write updates. If not set, a
blind "overwrite" update happens.
string etag = 8;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
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).
map<string, string> labels = 9;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
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).
map<string, string> labels = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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).
map<string, string> labels = 9;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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).
map<string, string> labels = 9;
| Parameter |
|---|
| Name | Description |
key | String
|
getMetadata()
public Struct getMetadata()
Properties of the Context.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
.google.protobuf.Struct metadata = 15;
| Returns |
|---|
| Type | Description |
Struct | The metadata.
|
getMetadataOrBuilder()
public StructOrBuilder getMetadataOrBuilder()
Properties of the Context.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
.google.protobuf.Struct metadata = 15;
getName()
Output only. The resource name of the Context.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the Context.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParentContexts(int index)
public String getParentContexts(int index)
Output only. A list of resource names of Contexts that are parents of this
Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The parentContexts at the given index.
|
getParentContextsBytes(int index)
public ByteString getParentContextsBytes(int index)
Output only. A list of resource names of Contexts that are parents of this
Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the parentContexts at the given index.
|
getParentContextsCount()
public int getParentContextsCount()
Output only. A list of resource names of Contexts that are parents of this
Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
int | The count of parentContexts.
|
getParentContextsList()
public ProtocolStringList getParentContextsList()
Output only. A list of resource names of Contexts that are parents of this
Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<Context> getParserForType()
Overrides
getSchemaTitle()
public String getSchemaTitle()
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.
string schema_title = 13;
| Returns |
|---|
| Type | Description |
String | The schemaTitle.
|
getSchemaTitleBytes()
public ByteString getSchemaTitleBytes()
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.
string schema_title = 13;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for schemaTitle.
|
getSchemaVersion()
public String getSchemaVersion()
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.
string schema_version = 14;
| Returns |
|---|
| Type | Description |
String | The schemaVersion.
|
getSchemaVersionBytes()
public ByteString getSchemaVersionBytes()
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.
string schema_version = 14;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for schemaVersion.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasMetadata()
public boolean hasMetadata()
Properties of the Context.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
.google.protobuf.Struct metadata = 15;
| Returns |
|---|
| Type | Description |
boolean | Whether the metadata field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Context.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Context.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
