Struct CreateIndexRequest 

#[non_exhaustive]
pub struct CreateIndexRequest {
    pub parent: String,
    pub index_id: String,
    pub index: Option<Index>,
    pub request_id: String,
    /* private fields */
}

Message for creating an Index.

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.

parent: String

Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection}

index_id: String

Required. ID of the Index to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

index: Option<Index>

Required. The resource being created

request_id: String

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Implementations

impl CreateIndexRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

let x = CreateIndexRequest::new().set_parent("example");

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

Sets the value of index_id.

Example

let x = CreateIndexRequest::new().set_index_id("example");

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

where T: Into<Index>,

Sets the value of index.

Example

use google_cloud_vectorsearch_v1::model::Index;
let x = CreateIndexRequest::new().set_index(Index::default()/* use setters */);

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

where T: Into<Index>,

Sets or clears the value of index.

Example

use google_cloud_vectorsearch_v1::model::Index;
let x = CreateIndexRequest::new().set_or_clear_index(Some(Index::default()/* use setters */));
let x = CreateIndexRequest::new().set_or_clear_index(None::<Index>);

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

Sets the value of request_id.

Example

let x = CreateIndexRequest::new().set_request_id("example");

Trait Implementations

impl Clone for CreateIndexRequest

fn clone(&self) -> CreateIndexRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIndexRequest

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

Formats the value using the given formatter.

impl Default for CreateIndexRequest

fn default() -> CreateIndexRequest

Returns the “default value” for a type.

impl Message for CreateIndexRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CreateIndexRequest

fn eq(&self, other: &CreateIndexRequest) -> 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 CreateIndexRequest