Struct google_api_proto::google::cloud::clouddms::v1::DescribeDatabaseEntitiesRequest

pub struct DescribeDatabaseEntitiesRequest {
    pub conversion_workspace: String,
    pub page_size: i32,
    pub page_token: String,
    pub tree: i32,
    pub uncommitted: bool,
    pub commit_id: String,
    pub filter: String,
    pub view: i32,
}

Request message for ‘DescribeDatabaseEntities’ request.

Fields

conversion_workspace: String

Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

page_size: i32

Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

page_token: String

Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.

tree: i32

Required. The tree to fetch.

uncommitted: bool

Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.

commit_id: String

Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

filter: String

Optional. Filter the returned entities based on AIP-160 standard.

view: i32

Optional. Results view based on AIP-157

Implementations

impl DescribeDatabaseEntitiesRequest

pub fn tree(&self) -> DbTreeType

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

pub fn set_tree(&mut self, value: DbTreeType)

Sets tree to the provided enum value.

pub fn view(&self) -> DatabaseEntityView

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: DatabaseEntityView)

Sets view to the provided enum value.

Trait Implementations

impl Clone for DescribeDatabaseEntitiesRequest

fn clone(&self) -> DescribeDatabaseEntitiesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDatabaseEntitiesRequest

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

Formats the value using the given formatter.

impl Default for DescribeDatabaseEntitiesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for DescribeDatabaseEntitiesRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for DescribeDatabaseEntitiesRequest

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

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

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

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

impl StructuralPartialEq for DescribeDatabaseEntitiesRequest