Database Migration v1 API - Class DescribeDatabaseEntitiesRequest (2.5.0) 

public sealed class DescribeDatabaseEntitiesRequest : IMessage<DescribeDatabaseEntitiesRequest>, IEquatable<DescribeDatabaseEntitiesRequest>, IDeepCloneable<DescribeDatabaseEntitiesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Database Migration v1 API class DescribeDatabaseEntitiesRequest.

Request message for 'DescribeDatabaseEntities' request.

Inheritance

object > DescribeDatabaseEntitiesRequest

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

DescribeDatabaseEntitiesRequest()

public DescribeDatabaseEntitiesRequest()

DescribeDatabaseEntitiesRequest(DescribeDatabaseEntitiesRequest)

public DescribeDatabaseEntitiesRequest(DescribeDatabaseEntitiesRequest other)
Parameter
Name Description
other DescribeDatabaseEntitiesRequest

Properties

CommitId

public string CommitId { get; set; }

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

Property Value
Type Description
string

ConversionWorkspace

public string ConversionWorkspace { get; set; }

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}.

Property Value
Type Description
string

ConversionWorkspaceAsConversionWorkspaceName

public ConversionWorkspaceName ConversionWorkspaceAsConversionWorkspaceName { get; set; }

ConversionWorkspaceName-typed view over the ConversionWorkspace resource name property.

Property Value
Type Description
ConversionWorkspaceName

Filter

public string Filter { get; set; }

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

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Tree

public DescribeDatabaseEntitiesRequest.Types.DBTreeType Tree { get; set; }

Required. The tree to fetch.

Property Value
Type Description
DescribeDatabaseEntitiesRequestTypesDBTreeType

Uncommitted

public bool Uncommitted { get; set; }

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.

Property Value
Type Description
bool

View

public DatabaseEntityView View { get; set; }

Optional. Results view based on AIP-157

Property Value
Type Description
DatabaseEntityView