Package com.google.cloud.aiplatform.v1
Interface ContextOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Context,Context.Builder
public interface ContextOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)The labels with user-defined metadata to organize your Contexts.com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.StringgetDescription()Description of the Contextcom.google.protobuf.ByteStringgetDescriptionBytes()Description of the ContextStringgetDisplayName()User provided display name of the Context.com.google.protobuf.ByteStringgetDisplayNameBytes()User provided display name of the Context.StringgetEtag()An eTag used to perform consistent read-modify-write updates.com.google.protobuf.ByteStringgetEtagBytes()An eTag used to perform consistent read-modify-write updates.Map<String,String>getLabels()Deprecated.intgetLabelsCount()The labels with user-defined metadata to organize your Contexts.Map<String,String>getLabelsMap()The labels with user-defined metadata to organize your Contexts.StringgetLabelsOrDefault(String key, String defaultValue)The labels with user-defined metadata to organize your Contexts.StringgetLabelsOrThrow(String key)The labels with user-defined metadata to organize your Contexts.com.google.protobuf.StructgetMetadata()Properties of the Context.com.google.protobuf.StructOrBuildergetMetadataOrBuilder()Properties of the Context.StringgetName()Immutable.com.google.protobuf.ByteStringgetNameBytes()Immutable.StringgetParentContexts(int index)Output only.com.google.protobuf.ByteStringgetParentContextsBytes(int index)Output only.intgetParentContextsCount()Output only.List<String>getParentContextsList()Output only.StringgetSchemaTitle()The title of the schema describing the metadata.com.google.protobuf.ByteStringgetSchemaTitleBytes()The title of the schema describing the metadata.StringgetSchemaVersion()The version of the schema in schema_name to use.com.google.protobuf.ByteStringgetSchemaVersionBytes()The version of the schema in schema_name to use.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasMetadata()Properties of the Context.booleanhasUpdateTime()Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
String getName()
Immutable. The resource name of the Context.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
Immutable. The resource name of the Context.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()
User provided display name of the Context. May be up to 128 Unicode characters.
string display_name = 2;- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()
User provided display name of the Context. May be up to 128 Unicode characters.
string display_name = 2;- Returns:
- The bytes for displayName.
-
getEtag
String getEtag()
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 8;- Returns:
- The etag.
-
getEtagBytes
com.google.protobuf.ByteString getEtagBytes()
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 8;- Returns:
- The bytes for etag.
-
getLabelsCount
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;
-
containsLabels
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;
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.
-
getLabelsMap
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 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 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;
-
hasCreateTime
boolean hasCreateTime()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Context was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
hasUpdateTime
boolean hasUpdateTime()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Context was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getParentContextsList
List<String> 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) = { ... }- Returns:
- A list containing the parentContexts.
-
getParentContextsCount
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:
- The count of parentContexts.
-
getParentContexts
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) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The parentContexts at the given index.
-
getParentContextsBytes
com.google.protobuf.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) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the parentContexts at the given index.
-
getSchemaTitle
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:
- The schemaTitle.
-
getSchemaTitleBytes
com.google.protobuf.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:
- The bytes for schemaTitle.
-
getSchemaVersion
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:
- The schemaVersion.
-
getSchemaVersionBytes
com.google.protobuf.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:
- The bytes for schemaVersion.
-
hasMetadata
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:
- Whether the metadata field is set.
-
getMetadata
com.google.protobuf.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:
- The metadata.
-
getMetadataOrBuilder
com.google.protobuf.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;
-
getDescription
String getDescription()
Description of the Context
string description = 16;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
Description of the Context
string description = 16;- Returns:
- The bytes for description.
-
-