Class ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<DescribeDatabaseEntitiesResponse>
DatabaseMigrationServiceBaseServiceRequest<DescribeDatabaseEntitiesResponse>
ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest
Implements
Inherited Members
Namespace: Google.Apis.DatabaseMigrationService.v1
Assembly: Google.Apis.DatabaseMigrationService.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest : DatabaseMigrationServiceBaseServiceRequest<DescribeDatabaseEntitiesResponse>, IClientServiceRequest<DescribeDatabaseEntitiesResponse>, IClientServiceRequest

Constructors

DescribeDatabaseEntitiesRequest(IClientService, string)

Constructs a new DescribeDatabaseEntities request.

Declaration
public DescribeDatabaseEntitiesRequest(IClientService service, string conversionWorkspace)
Parameters
Type Name Description
IClientService service
string conversionWorkspace

Properties

CommitId

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

Declaration
[RequestParameter("commitId", RequestParameterType.Query)]
public virtual string CommitId { get; set; }
Property Value
Type Description
string

ConversionWorkspace

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

Declaration
[RequestParameter("conversionWorkspace", RequestParameterType.Path)]
public virtual string ConversionWorkspace { get; }
Property Value
Type Description
string

Filter

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

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

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

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Tree

Required. The tree to fetch.

Declaration
[RequestParameter("tree", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest.TreeEnum? Tree { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest.TreeEnum?

Uncommitted

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.

Declaration
[RequestParameter("uncommitted", RequestParameterType.Query)]
public virtual bool? Uncommitted { get; set; }
Property Value
Type Description
bool?

View

Optional. Results view based on AIP-157

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest.ViewEnum? View { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.ConversionWorkspacesResource.DescribeDatabaseEntitiesRequest.ViewEnum?

Methods

InitParameters()

Initializes DescribeDatabaseEntities parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements