Show / Hide Table of Contents

Namespace Google.Apis.CloudDataplex.v1

Classes

CloudDataplexBaseServiceRequest<TResponse>

A base abstract class for CloudDataplex requests.

CloudDataplexService

The CloudDataplex Service.

CloudDataplexService.Scope

Available OAuth 2.0 scopes for use with the Cloud Dataplex API.

CloudDataplexService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Dataplex API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.DataAttributeBindingsResource

The "dataAttributeBindings" collection of methods.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.CreateRequest

Create a DataAttributeBinding resource.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.DeleteRequest

Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.GetRequest

Retrieves a DataAttributeBinding resource.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.ListRequest

Lists DataAttributeBinding resources in a project and location.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.PatchRequest

Updates a DataAttributeBinding resource.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.DataAttributeBindingsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.DataScansResource

The "dataScans" collection of methods.

ProjectsResource.LocationsResource.DataScansResource.CreateRequest

Creates a DataScan resource.

ProjectsResource.LocationsResource.DataScansResource.DeleteRequest

Deletes a DataScan resource.

ProjectsResource.LocationsResource.DataScansResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.DataScansResource.GetRequest

Gets a DataScan resource.

ProjectsResource.LocationsResource.DataScansResource.JobsResource

The "jobs" collection of methods.

ProjectsResource.LocationsResource.DataScansResource.JobsResource.GetRequest

Gets a DataScanJob resource.

ProjectsResource.LocationsResource.DataScansResource.JobsResource.ListRequest

Lists DataScanJobs under the given DataScan.

ProjectsResource.LocationsResource.DataScansResource.ListRequest

Lists DataScans.

ProjectsResource.LocationsResource.DataScansResource.PatchRequest

Updates a DataScan resource.

ProjectsResource.LocationsResource.DataScansResource.RunRequest

Runs an on-demand execution of a DataScan

ProjectsResource.LocationsResource.DataScansResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.DataScansResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.DataTaxonomiesResource

The "dataTaxonomies" collection of methods.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource

The "attributes" collection of methods.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.CreateRequest

Create a DataAttribute resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.DeleteRequest

Deletes a Data Attribute resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.GetRequest

Retrieves a Data Attribute resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.ListRequest

Lists Data Attribute resources in a DataTaxonomy.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.PatchRequest

Updates a DataAttribute resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.DataTaxonomiesResource.AttributesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.DataTaxonomiesResource.CreateRequest

Create a DataTaxonomy resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.DeleteRequest

Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

ProjectsResource.LocationsResource.DataTaxonomiesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.DataTaxonomiesResource.GetRequest

Retrieves a DataTaxonomy resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.ListRequest

Lists DataTaxonomy resources in a project and location.

ProjectsResource.LocationsResource.DataTaxonomiesResource.PatchRequest

Updates a DataTaxonomy resource.

ProjectsResource.LocationsResource.DataTaxonomiesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.DataTaxonomiesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.GetRequest

Gets information about a location.

ProjectsResource.LocationsResource.LakesResource

The "lakes" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ActionsResource

The "actions" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ActionsResource.ListRequest

Lists action resources in a lake.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource

The "contentitems" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.CreateRequest

Create a content.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.DeleteRequest

Delete a content.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.GetIamPolicyRequest

Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.GetRequest

Get a content resource.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.ListRequest

List content.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.PatchRequest

Update a content. Only supports full resource update.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.SetIamPolicyRequest

Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.TestIamPermissionsRequest

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.ContentResource

The "content" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ContentResource.CreateRequest

Create a content.

ProjectsResource.LocationsResource.LakesResource.ContentResource.DeleteRequest

Delete a content.

ProjectsResource.LocationsResource.LakesResource.ContentResource.GetIamPolicyRequest

Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

ProjectsResource.LocationsResource.LakesResource.ContentResource.GetRequest

Get a content resource.

ProjectsResource.LocationsResource.LakesResource.ContentResource.ListRequest

List content.

ProjectsResource.LocationsResource.LakesResource.ContentResource.PatchRequest

Update a content. Only supports full resource update.

ProjectsResource.LocationsResource.LakesResource.ContentResource.SetIamPolicyRequest

Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.

ProjectsResource.LocationsResource.LakesResource.ContentResource.TestIamPermissionsRequest

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.CreateRequest

Creates a lake resource.

ProjectsResource.LocationsResource.LakesResource.DeleteRequest

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource

The "environments" collection of methods.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.CreateRequest

Create an environment resource.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.DeleteRequest

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.GetRequest

Get environment resource.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.ListRequest

Lists environments under the given lake.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.PatchRequest

Update the environment resource.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.SessionsResource

The "sessions" collection of methods.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.SessionsResource.ListRequest

Lists session resources in an environment.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.LakesResource.EnvironmentsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.LakesResource.GetRequest

Retrieves a lake resource.

ProjectsResource.LocationsResource.LakesResource.ListRequest

Lists lake resources in a project and location.

ProjectsResource.LocationsResource.LakesResource.PatchRequest

Updates a lake resource.

ProjectsResource.LocationsResource.LakesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.LakesResource.TasksResource

The "tasks" collection of methods.

ProjectsResource.LocationsResource.LakesResource.TasksResource.CreateRequest

Creates a task resource within a lake.

ProjectsResource.LocationsResource.LakesResource.TasksResource.DeleteRequest

Delete the task resource.

ProjectsResource.LocationsResource.LakesResource.TasksResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.LakesResource.TasksResource.GetRequest

Get task resource.

ProjectsResource.LocationsResource.LakesResource.TasksResource.JobsResource

The "jobs" collection of methods.

ProjectsResource.LocationsResource.LakesResource.TasksResource.JobsResource.CancelRequest

Cancel jobs running for the task resource.

ProjectsResource.LocationsResource.LakesResource.TasksResource.JobsResource.GetRequest

Get job resource.

ProjectsResource.LocationsResource.LakesResource.TasksResource.JobsResource.ListRequest

Lists Jobs under the given task.

ProjectsResource.LocationsResource.LakesResource.TasksResource.ListRequest

Lists tasks under the given lake.

ProjectsResource.LocationsResource.LakesResource.TasksResource.PatchRequest

Update the task resource.

ProjectsResource.LocationsResource.LakesResource.TasksResource.RunRequest

Run an on demand execution of a Task.

ProjectsResource.LocationsResource.LakesResource.TasksResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.LakesResource.TasksResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.ZonesResource

The "zones" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.ActionsResource

The "actions" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.ActionsResource.ListRequest

Lists action resources in a zone.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource

The "assets" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.ActionsResource

The "actions" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.ActionsResource.ListRequest

Lists action resources in an asset.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.CreateRequest

Creates an asset resource.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.DeleteRequest

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.GetRequest

Retrieves an asset resource.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.ListRequest

Lists asset resources in a zone.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.PatchRequest

Updates an asset resource.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.AssetsResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.CreateRequest

Creates a zone resource within a lake.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.DeleteRequest

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource

The "entities" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.CreateRequest

Create a metadata entity.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.DeleteRequest

Delete a metadata entity.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.GetRequest

Get a metadata entity.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.ListRequest

List metadata entities in a zone.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.PartitionsResource

The "partitions" collection of methods.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.PartitionsResource.CreateRequest

Create a metadata partition.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.PartitionsResource.DeleteRequest

Delete a metadata partition.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.PartitionsResource.GetRequest

Get a metadata partition of an entity.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.PartitionsResource.ListRequest

List metadata partitions of an entity.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.UpdateRequest

Update a metadata entity. Only supports full resource update.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.GetRequest

Retrieves a zone resource.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.ListRequest

Lists zone resources in a lake.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.PatchRequest

Updates a zone resource.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.ListRequest

Lists information about the supported locations for this service.

ProjectsResource.LocationsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.LocationsResource.OperationsResource.DeleteRequest

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

ProjectsResource.LocationsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/{name=users/}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Enums

CloudDataplexBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudDataplexBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

ProjectsResource.LocationsResource.DataScansResource.GetRequest.ViewEnum

Optional. Select the DataScan view to return. Defaults to BASIC.

ProjectsResource.LocationsResource.DataScansResource.JobsResource.GetRequest.ViewEnum

Optional. Select the DataScanJob view to return. Defaults to BASIC.

ProjectsResource.LocationsResource.LakesResource.ContentitemsResource.GetRequest.ViewEnum

Optional. Specify content view to make a partial request.

ProjectsResource.LocationsResource.LakesResource.ContentResource.GetRequest.ViewEnum

Optional. Specify content view to make a partial request.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.GetRequest.ViewEnum

Optional. Used to select the subset of entity information to return. Defaults to BASIC.

ProjectsResource.LocationsResource.LakesResource.ZonesResource.EntitiesResource.ListRequest.ViewEnum

Required. Specify the entity view to make a partial list request.

In This Article
Back to top Generated by DocFX