Struct googapis::google::cloud::gaming::v1::ListGameServerClustersRequest

pub struct ListGameServerClustersRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    pub order_by: String,
    pub view: i32,
}

Request message for GameServerClustersService.ListGameServerClusters.

Fields

parent: String

Required. The parent resource name, in the following form: “projects/{project}/locations/{location}/realms/{realm}”.

page_size: i32

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1.ListGameServerClustersResponse.next_page_token] to determine if there are more GameServerClusters left to be queried.

page_token: String

Optional. The next_page_token value returned from a previous List request, if any.

filter: String

Optional. The filter to apply to list results.

order_by: String

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

view: i32

Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Implementations

impl ListGameServerClustersRequest

pub fn view(&self) -> GameServerClusterView

Returns the enum value of view, or the default if the field is set to an invalid enum value.

pub fn set_view(&mut self, value: GameServerClusterView)

Sets view to the provided enum value.

Trait Implementations

impl Clone for ListGameServerClustersRequest

fn clone(&self) -> ListGameServerClustersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGameServerClustersRequest

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

Formats the value using the given formatter.

impl Default for ListGameServerClustersRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListGameServerClustersRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ListGameServerClustersRequest> for ListGameServerClustersRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ListGameServerClustersRequest