Struct CachedContent 

#[non_exhaustive]
pub struct CachedContent {
    pub name: String,
    pub display_name: String,
    pub model: String,
    pub system_instruction: Option<Content>,
    pub contents: Vec<Content>,
    pub tools: Vec<Tool>,
    pub tool_config: Option<ToolConfig>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub usage_metadata: Option<UsageMetadata>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub expiration: Option<Expiration>,
    /* private fields */
}

Available on crate feature gen-ai-cache-service only.

A resource used in LLM queries for users to explicitly specify what to cache and how to cache.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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

display_name: String

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

model: String

Immutable. The name of the Model to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}

system_instruction: Option<Content>

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

contents: Vec<Content>

Optional. Input only. Immutable. The content to cache

tools: Vec<Tool>

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

tool_config: Option<ToolConfig>

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

create_time: Option<Timestamp>

Output only. Creation time of the cache entry.

update_time: Option<Timestamp>

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

usage_metadata: Option<UsageMetadata>

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

encryption_spec: Option<EncryptionSpec>

Input only. Immutable. Customer-managed encryption key spec for a CachedContent. If set, this CachedContent and all its sub-resources will be secured by this key.

expiration: Option<Expiration>

Expiration time of the cached content.

Implementations

impl CachedContent

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = CachedContent::new().set_name("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = CachedContent::new().set_display_name("example");

pub fn set_model<T: Into<String>>(self, v: T) -> Self

Sets the value of model.

Example

let x = CachedContent::new().set_model("example");

pub fn set_system_instruction<T>(self, v: T) -> Self

where T: Into<Content>,

Sets the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CachedContent::new().set_system_instruction(Content::default()/* use setters */);

pub fn set_or_clear_system_instruction<T>(self, v: Option<T>) -> Self

where T: Into<Content>,

Sets or clears the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CachedContent::new().set_or_clear_system_instruction(Some(Content::default()/* use setters */));
let x = CachedContent::new().set_or_clear_system_instruction(None::<Content>);

pub fn set_contents<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Content>,

Sets the value of contents.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CachedContent::new()
    .set_contents([
        Content::default()/* use setters */,
        Content::default()/* use (different) setters */,
    ]);

pub fn set_tools<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Tool>,

Sets the value of tools.

Example

use google_cloud_aiplatform_v1::model::Tool;
let x = CachedContent::new()
    .set_tools([
        Tool::default()/* use setters */,
        Tool::default()/* use (different) setters */,
    ]);

pub fn set_tool_config<T>(self, v: T) -> Self

where T: Into<ToolConfig>,

Sets the value of tool_config.

Example

use google_cloud_aiplatform_v1::model::ToolConfig;
let x = CachedContent::new().set_tool_config(ToolConfig::default()/* use setters */);

pub fn set_or_clear_tool_config<T>(self, v: Option<T>) -> Self

where T: Into<ToolConfig>,

Sets or clears the value of tool_config.

Example

use google_cloud_aiplatform_v1::model::ToolConfig;
let x = CachedContent::new().set_or_clear_tool_config(Some(ToolConfig::default()/* use setters */));
let x = CachedContent::new().set_or_clear_tool_config(None::<ToolConfig>);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = CachedContent::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = CachedContent::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_usage_metadata<T>(self, v: T) -> Self

where T: Into<UsageMetadata>,

Sets the value of usage_metadata.

Example

use google_cloud_aiplatform_v1::model::cached_content::UsageMetadata;
let x = CachedContent::new().set_usage_metadata(UsageMetadata::default()/* use setters */);

pub fn set_or_clear_usage_metadata<T>(self, v: Option<T>) -> Self

where T: Into<UsageMetadata>,

Sets or clears the value of usage_metadata.

Example

use google_cloud_aiplatform_v1::model::cached_content::UsageMetadata;
let x = CachedContent::new().set_or_clear_usage_metadata(Some(UsageMetadata::default()/* use setters */));
let x = CachedContent::new().set_or_clear_usage_metadata(None::<UsageMetadata>);

pub fn set_encryption_spec<T>(self, v: T) -> Self

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = CachedContent::new().set_encryption_spec(EncryptionSpec::default()/* use setters */);

pub fn set_or_clear_encryption_spec<T>(self, v: Option<T>) -> Self

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = CachedContent::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = CachedContent::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

pub fn set_expiration<T: Into<Option<Expiration>>>(self, v: T) -> Self

Sets the value of expiration.

Note that all the setters affecting expiration are mutually exclusive.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_expiration(Some(
    google_cloud_aiplatform_v1::model::cached_content::Expiration::ExpireTime(Timestamp::default().into())));

pub fn expire_time(&self) -> Option<&Box<Timestamp>>

The value of expiration if it holds a ExpireTime, None if the field is not set or holds a different branch.

pub fn set_expire_time<T: Into<Box<Timestamp>>>(self, v: T) -> Self

Sets the value of expiration to hold a ExpireTime.

Note that all the setters affecting expiration are mutually exclusive.

Example

use wkt::Timestamp;
let x = CachedContent::new().set_expire_time(Timestamp::default()/* use setters */);
assert!(x.expire_time().is_some());
assert!(x.ttl().is_none());

pub fn ttl(&self) -> Option<&Box<Duration>>

The value of expiration if it holds a Ttl, None if the field is not set or holds a different branch.

pub fn set_ttl<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of expiration to hold a Ttl.

Note that all the setters affecting expiration are mutually exclusive.

Example

use wkt::Duration;
let x = CachedContent::new().set_ttl(Duration::default()/* use setters */);
assert!(x.ttl().is_some());
assert!(x.expire_time().is_none());

Trait Implementations

impl Clone for CachedContent

fn clone(&self) -> CachedContent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CachedContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CachedContent

fn default() -> CachedContent

Returns the “default value” for a type.

impl Message for CachedContent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CachedContent

fn eq(&self, other: &CachedContent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CachedContent