Interface CachedContentOrBuilder (3.56.0)

public interface CachedContentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContents(int index)

public abstract Content getContents(int index)

Optional. Input only. Immutable. The content to cache

repeated .google.cloud.aiplatform.v1beta1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Content

getContentsCount()

public abstract int getContentsCount()

Optional. Input only. Immutable. The content to cache

repeated .google.cloud.aiplatform.v1beta1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
int

getContentsList()

public abstract List<Content> getContentsList()

Optional. Input only. Immutable. The content to cache

repeated .google.cloud.aiplatform.v1beta1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
List<Content>

getContentsOrBuilder(int index)

public abstract ContentOrBuilder getContentsOrBuilder(int index)

Optional. Input only. Immutable. The content to cache

repeated .google.cloud.aiplatform.v1beta1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ContentOrBuilder

getContentsOrBuilderList()

public abstract List<? extends ContentOrBuilder> getContentsOrBuilderList()

Optional. Input only. Immutable. The content to cache

repeated .google.cloud.aiplatform.v1beta1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ContentOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creatation time of the cache entry.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creatation time of the cache entry.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. Immutable. The user-generated meaningful display name of the cached content.

string display_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Immutable. The user-generated meaningful display name of the cached content.

string display_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for displayName.

getExpirationCase()

public abstract CachedContent.ExpirationCase getExpirationCase()
Returns
Type Description
CachedContent.ExpirationCase

getExpireTime()

public abstract Timestamp getExpireTime()

Timestamp of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.

.google.protobuf.Timestamp expire_time = 9;

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Timestamp of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.

.google.protobuf.Timestamp expire_time = 9;

Returns
Type Description
TimestampOrBuilder

getModel()

public abstract String getModel()

Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The model.

getModelBytes()

public abstract ByteString getModelBytes()

Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for model.

getName()

public abstract String getName()

Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getSystemInstruction()

public abstract Content getSystemInstruction()

Optional. Input only. Immutable. Developer set system instruction. Currently, text only

.google.cloud.aiplatform.v1beta1.Content system_instruction = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Content

The systemInstruction.

getSystemInstructionOrBuilder()

public abstract ContentOrBuilder getSystemInstructionOrBuilder()

Optional. Input only. Immutable. Developer set system instruction. Currently, text only

.google.cloud.aiplatform.v1beta1.Content system_instruction = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ContentOrBuilder

getToolConfig()

public abstract ToolConfig getToolConfig()

Optional. Input only. Immutable. Tool config. This config is shared for all tools

.google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ToolConfig

The toolConfig.

getToolConfigOrBuilder()

public abstract ToolConfigOrBuilder getToolConfigOrBuilder()

Optional. Input only. Immutable. Tool config. This config is shared for all tools

.google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ToolConfigOrBuilder

getTools(int index)

public abstract Tool getTools(int index)

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Tool

getToolsCount()

public abstract int getToolsCount()

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
int

getToolsList()

public abstract List<Tool> getToolsList()

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
List<Tool>

getToolsOrBuilder(int index)

public abstract ToolOrBuilder getToolsOrBuilder(int index)

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ToolOrBuilder

getToolsOrBuilderList()

public abstract List<? extends ToolOrBuilder> getToolsOrBuilderList()

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ToolOrBuilder>

getTtl()

public abstract Duration getTtl()

Input only. The TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 10 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Duration

The ttl.

getTtlOrBuilder()

public abstract DurationOrBuilder getTtlOrBuilder()

Input only. The TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 10 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
DurationOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. When the cache entry was last updated in UTC time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. When the cache entry was last updated in UTC time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUsageMetadata()

public abstract CachedContent.UsageMetadata getUsageMetadata()

Output only. Metadata on the usage of the cached content.

.google.cloud.aiplatform.v1beta1.CachedContent.UsageMetadata usage_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CachedContent.UsageMetadata

The usageMetadata.

getUsageMetadataOrBuilder()

public abstract CachedContent.UsageMetadataOrBuilder getUsageMetadataOrBuilder()

Output only. Metadata on the usage of the cached content.

.google.cloud.aiplatform.v1beta1.CachedContent.UsageMetadata usage_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CachedContent.UsageMetadataOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creatation time of the cache entry.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Timestamp of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.

.google.protobuf.Timestamp expire_time = 9;

Returns
Type Description
boolean

Whether the expireTime field is set.

hasSystemInstruction()

public abstract boolean hasSystemInstruction()

Optional. Input only. Immutable. Developer set system instruction. Currently, text only

.google.cloud.aiplatform.v1beta1.Content system_instruction = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the systemInstruction field is set.

hasToolConfig()

public abstract boolean hasToolConfig()

Optional. Input only. Immutable. Tool config. This config is shared for all tools

.google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the toolConfig field is set.

hasTtl()

public abstract boolean hasTtl()

Input only. The TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 10 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the ttl field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. When the cache entry was last updated in UTC time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasUsageMetadata()

public abstract boolean hasUsageMetadata()

Output only. Metadata on the usage of the cached content.

.google.cloud.aiplatform.v1beta1.CachedContent.UsageMetadata usage_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the usageMetadata field is set.