Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest (v1.1.0)

Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest.

Request message for 'DescribeDatabaseEntities' request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#commit_id

def commit_id() -> ::String
Returns
  • (::String) — Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

#commit_id=

def commit_id=(value) -> ::String
Parameter
  • value (::String) — Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
Returns
  • (::String) — Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

#conversion_workspace

def conversion_workspace() -> ::String
Returns
  • (::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}.

#conversion_workspace=

def conversion_workspace=(value) -> ::String
Parameter
  • value (::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}.
Returns
  • (::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}.

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. Filter the returned entities based on AIP-160 standard.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. Filter the returned entities based on AIP-160 standard.
Returns
  • (::String) — Optional. Filter the returned entities based on AIP-160 standard.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
Returns
  • (::Integer) — Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

#page_token

def page_token() -> ::String
Returns
  • (::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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def tree() -> ::Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest::DBTreeType
Returns

#tree=

def tree=(value) -> ::Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest::DBTreeType
Parameter
Returns

#uncommitted

def uncommitted() -> ::Boolean
Returns
  • (::Boolean) — 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.

#uncommitted=

def uncommitted=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#view

def view() -> ::Google::Cloud::CloudDMS::V1::DatabaseEntityView
Returns

#view=

def view=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseEntityView
Parameter
Returns