From 2d0cd12f1711e71e58e1835341e269e339096e63 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 22 Nov 2022 07:07:57 +0000 Subject: [PATCH] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - resources.projects.resources.locations.resources.dataAttributeBindings.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.dataScans.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.dataScans.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.dataScans.methods.get (Total Keys: 27) - resources.projects.resources.locations.resources.dataScans.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.dataScans.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.dataScans.methods.run (Total Keys: 12) - resources.projects.resources.locations.resources.dataScans.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataScans.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.get (Total Keys: 13) - resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.dataTaxonomies.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.dataTaxonomies.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.testIamPermissions (Total Keys: 12) - schemas.GoogleCloudDataplexV1DataProfileResult (Total Keys: 66) - schemas.GoogleCloudDataplexV1DataProfileSpec (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityDimensionResult (Total Keys: 3) - schemas.GoogleCloudDataplexV1DataQualityResult (Total Keys: 10) - schemas.GoogleCloudDataplexV1DataQualityRule (Total Keys: 58) - schemas.GoogleCloudDataplexV1DataQualitySpec (Total Keys: 4) - schemas.GoogleCloudDataplexV1DataScan (Total Keys: 57) - schemas.GoogleCloudDataplexV1DataSource (Total Keys: 3) - schemas.GoogleCloudDataplexV1ListDataScanJobsResponse (Total Keys: 5) - schemas.GoogleCloudDataplexV1ListDataScansResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1RunDataScanRequest (Total Keys: 2) - schemas.GoogleCloudDataplexV1RunDataScanResponse (Total Keys: 3) - schemas.GoogleCloudDataplexV1ScannedData (Total Keys: 8) - schemas.GoogleCloudDataplexV1Trigger (Total Keys: 9) --- ...jects.locations.dataAttributeBindings.html | 258 ++ ...aplex_v1.projects.locations.dataScans.html | 1389 ++++++++ ..._v1.projects.locations.dataScans.jobs.html | 487 +++ ...s.locations.dataTaxonomies.attributes.html | 258 ++ ..._v1.projects.locations.dataTaxonomies.html | 263 ++ docs/dyn/dataplex_v1.projects.locations.html | 15 + .../documents/dataplex.v1.json | 2893 +++++++++++++---- 7 files changed, 4854 insertions(+), 709 deletions(-) create mode 100644 docs/dyn/dataplex_v1.projects.locations.dataAttributeBindings.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.dataScans.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html diff --git a/docs/dyn/dataplex_v1.projects.locations.dataAttributeBindings.html b/docs/dyn/dataplex_v1.projects.locations.dataAttributeBindings.html new file mode 100644 index 00000000000..d7822f4d13e --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataAttributeBindings.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . dataAttributeBindings

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

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

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

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

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

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.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+      { # Associates members, or principals, with a role.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) + 
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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html new file mode 100644 index 00000000000..379fae78ff5 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -0,0 +1,1389 @@ + + + +

Cloud Dataplex API . projects . locations . dataScans

+

Instance Methods

+

+ jobs() +

+

Returns the jobs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, dataScanId=None, x__xgafv=None)

+

Creates a dataScan resource.

+

+ delete(name, x__xgafv=None)

+

Delete the dataScan resource.

+

+ get(name, view=None, x__xgafv=None)

+

Get dataScan resource.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

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

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists dataScans.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Update the dataScan resource.

+

+ run(name, body=None, x__xgafv=None)

+

Run an on demand execution of a DataScan.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

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

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

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.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, dataScanId=None, x__xgafv=None) + 
Creates a dataScan resource.
+
+Args:
+  parent: string, Required. The resource name of the parent location: projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a user-visible job which provides the insights for the related data source. For examples: - Data Quality: generates queries based on the rules and run against the data to get data quality check results. - Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
+  "createTime": "A String", # Output only. The time when the scan was created.
+  "data": { # The data source for DataScan. # Required. The data source for DataScan.
+    "entity": "A String", # Immutable. The dataplex entity that contains the data for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
+  },
+  "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+    "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+      "fields": [ # The sequence of fields describing data in table entities.
+        { # Represents a column field within a table schema.
+          "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+          "name": "A String", # The name of the field.
+          "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+            "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+            "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+              "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                3.14,
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+              "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                "A String",
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+            "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+              "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+              "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+              "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+            },
+            "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+              { # The TopNValue defines the structure of output of top N values of a field.
+                "count": "A String", # The frequency count of the corresponding value in the field.
+                "value": "A String", # The value is the string value of the actual value from the field.
+              },
+            ],
+          },
+          "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+        },
+      ],
+    },
+    "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting.
+  },
+  "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+    "dimensions": [ # A list of results at the dimension-level.
+      { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+        "passed": True or False, # Whether the dimension passed or failed.
+      },
+    ],
+    "passed": True or False, # Overall data quality result -- true if all rules passed.
+    "rowCount": "A String", # The count of rows processed.
+    "rules": [ # A list of all the rules in a job, and their results.
+      { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+        "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+        "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+        "nullCount": "A String", # The number of rows with null values in the specified column.
+        "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+        "passed": True or False, # Whether the rule passed or failed.
+        "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+        "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+          "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+          "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+          "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+          "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+          },
+          "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+            "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+            "regex": "A String",
+          },
+          "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+            "sqlExpression": "A String",
+          },
+          "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+            "values": [
+              "A String",
+            ],
+          },
+          "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+            "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "statistic": "A String",
+            "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+            "sqlExpression": "A String",
+          },
+          "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+          "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+          },
+        },
+      },
+    ],
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting.
+    "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+      { # A rule captures data quality intent about a data source.
+        "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+        "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+        "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+        "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+        },
+        "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+          "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+          "regex": "A String",
+        },
+        "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+          "sqlExpression": "A String",
+        },
+        "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+          "values": [
+            "A String",
+          ],
+        },
+        "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+          "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "statistic": "A String",
+          "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+          "sqlExpression": "A String",
+        },
+        "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+        "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. Description of the scan. * Must be between 1-1024 characters.
+  "displayName": "A String", # Optional. User friendly display name. * Must be between 1-256 characters.
+  "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings. If not specified, the fields under it will use their default values.
+    "field": "A String", # Immutable. The unnested field (Date or Timestamp) that contains values that monotonically increase over time.
+    "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered. If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.
+      "onDemand": { # The scan runs one-time via RunDataScan API. # The scan runs one-time shortly after DataScan Creation.
+      },
+      "schedule": { # The scan is scheduled to run periodically. # The scan is scheduled to run periodically.
+        "cron": "A String", # Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". This field is required for Schedule scans.
+      },
+    },
+  },
+  "labels": { # Optional. User-defined labels for the scan.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+  "state": "A String", # Output only. Current state of the DataScan.
+  "type": "A String", # Output only. The type of DataScan.
+  "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
+  "updateTime": "A String", # Output only. The time when the scan was last updated.
+}
+
+  dataScanId: string, Required. DataScan identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Delete the dataScan resource.
+
+Args:
+  name: string, Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, view=None, x__xgafv=None) + 
Get dataScan resource.
+
+Args:
+  name: string, Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  view: string, Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.
+    Allowed values
+      DATA_SCAN_VIEW_UNSPECIFIED - The API will default to the BASIC view.
+      BASIC - Basic view that does not include spec and result.
+      FULL - Include everything.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a user-visible job which provides the insights for the related data source. For examples: - Data Quality: generates queries based on the rules and run against the data to get data quality check results. - Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
+  "createTime": "A String", # Output only. The time when the scan was created.
+  "data": { # The data source for DataScan. # Required. The data source for DataScan.
+    "entity": "A String", # Immutable. The dataplex entity that contains the data for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
+  },
+  "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+    "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+      "fields": [ # The sequence of fields describing data in table entities.
+        { # Represents a column field within a table schema.
+          "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+          "name": "A String", # The name of the field.
+          "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+            "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+            "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+              "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                3.14,
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+              "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                "A String",
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+            "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+              "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+              "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+              "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+            },
+            "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+              { # The TopNValue defines the structure of output of top N values of a field.
+                "count": "A String", # The frequency count of the corresponding value in the field.
+                "value": "A String", # The value is the string value of the actual value from the field.
+              },
+            ],
+          },
+          "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+        },
+      ],
+    },
+    "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting.
+  },
+  "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+    "dimensions": [ # A list of results at the dimension-level.
+      { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+        "passed": True or False, # Whether the dimension passed or failed.
+      },
+    ],
+    "passed": True or False, # Overall data quality result -- true if all rules passed.
+    "rowCount": "A String", # The count of rows processed.
+    "rules": [ # A list of all the rules in a job, and their results.
+      { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+        "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+        "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+        "nullCount": "A String", # The number of rows with null values in the specified column.
+        "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+        "passed": True or False, # Whether the rule passed or failed.
+        "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+        "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+          "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+          "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+          "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+          "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+          },
+          "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+            "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+            "regex": "A String",
+          },
+          "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+            "sqlExpression": "A String",
+          },
+          "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+            "values": [
+              "A String",
+            ],
+          },
+          "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+            "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "statistic": "A String",
+            "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+            "sqlExpression": "A String",
+          },
+          "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+          "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+          },
+        },
+      },
+    ],
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting.
+    "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+      { # A rule captures data quality intent about a data source.
+        "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+        "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+        "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+        "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+        },
+        "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+          "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+          "regex": "A String",
+        },
+        "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+          "sqlExpression": "A String",
+        },
+        "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+          "values": [
+            "A String",
+          ],
+        },
+        "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+          "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "statistic": "A String",
+          "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+          "sqlExpression": "A String",
+        },
+        "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+        "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. Description of the scan. * Must be between 1-1024 characters.
+  "displayName": "A String", # Optional. User friendly display name. * Must be between 1-256 characters.
+  "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings. If not specified, the fields under it will use their default values.
+    "field": "A String", # Immutable. The unnested field (Date or Timestamp) that contains values that monotonically increase over time.
+    "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered. If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.
+      "onDemand": { # The scan runs one-time via RunDataScan API. # The scan runs one-time shortly after DataScan Creation.
+      },
+      "schedule": { # The scan is scheduled to run periodically. # The scan is scheduled to run periodically.
+        "cron": "A String", # Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". This field is required for Schedule scans.
+      },
+    },
+  },
+  "labels": { # Optional. User-defined labels for the scan.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+  "state": "A String", # Output only. Current state of the DataScan.
+  "type": "A String", # Output only. The type of DataScan.
+  "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
+  "updateTime": "A String", # Output only. The time when the scan was last updated.
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists dataScans.
+
+Args:
+  parent: string, Required. projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  filter: string, Optional. Filter request.
+  orderBy: string, Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
+  pageSize: integer, Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 10 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List dataScans response.
+  "dataScans": [ # DataScans (metadata only) under the given parent location.
+    { # Represents a user-visible job which provides the insights for the related data source. For examples: - Data Quality: generates queries based on the rules and run against the data to get data quality check results. - Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
+      "createTime": "A String", # Output only. The time when the scan was created.
+      "data": { # The data source for DataScan. # Required. The data source for DataScan.
+        "entity": "A String", # Immutable. The dataplex entity that contains the data for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
+      },
+      "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+        "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+          "fields": [ # The sequence of fields describing data in table entities.
+            { # Represents a column field within a table schema.
+              "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+              "name": "A String", # The name of the field.
+              "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+                "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+                "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+                  "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                    3.14,
+                  ],
+                  "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                },
+                "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+                  "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                    "A String",
+                  ],
+                  "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                },
+                "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+                "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+                  "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+                  "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+                  "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+                },
+                "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+                  { # The TopNValue defines the structure of output of top N values of a field.
+                    "count": "A String", # The frequency count of the corresponding value in the field.
+                    "value": "A String", # The value is the string value of the actual value from the field.
+                  },
+                ],
+              },
+              "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+            },
+          ],
+        },
+        "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+        "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+          "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+            "end": "A String", # Value that marks the end of the range
+            "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+            "start": "A String", # Value that marks the start of the range
+          },
+        },
+      },
+      "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting.
+      },
+      "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+        "dimensions": [ # A list of results at the dimension-level.
+          { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+            "passed": True or False, # Whether the dimension passed or failed.
+          },
+        ],
+        "passed": True or False, # Overall data quality result -- true if all rules passed.
+        "rowCount": "A String", # The count of rows processed.
+        "rules": [ # A list of all the rules in a job, and their results.
+          { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+            "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+            "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+            "nullCount": "A String", # The number of rows with null values in the specified column.
+            "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+            "passed": True or False, # Whether the rule passed or failed.
+            "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+            "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+              "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+              "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+              "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+              "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+              },
+              "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+                "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+                "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+              },
+              "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+                "regex": "A String",
+              },
+              "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+                "sqlExpression": "A String",
+              },
+              "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+                "values": [
+                  "A String",
+                ],
+              },
+              "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+                "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "statistic": "A String",
+                "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+                "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+              },
+              "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+                "sqlExpression": "A String",
+              },
+              "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+              "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+              },
+            },
+          },
+        ],
+        "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+          "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+            "end": "A String", # Value that marks the end of the range
+            "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+            "start": "A String", # Value that marks the start of the range
+          },
+        },
+      },
+      "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting.
+        "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+          { # A rule captures data quality intent about a data source.
+            "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+            "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+            "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+            "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+            },
+            "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+              "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+              "regex": "A String",
+            },
+            "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+              "sqlExpression": "A String",
+            },
+            "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+              "values": [
+                "A String",
+              ],
+            },
+            "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+              "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "statistic": "A String",
+              "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+              "sqlExpression": "A String",
+            },
+            "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+            "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+            },
+          },
+        ],
+      },
+      "description": "A String", # Optional. Description of the scan. * Must be between 1-1024 characters.
+      "displayName": "A String", # Optional. User friendly display name. * Must be between 1-256 characters.
+      "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings. If not specified, the fields under it will use their default values.
+        "field": "A String", # Immutable. The unnested field (Date or Timestamp) that contains values that monotonically increase over time.
+        "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered. If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.
+          "onDemand": { # The scan runs one-time via RunDataScan API. # The scan runs one-time shortly after DataScan Creation.
+          },
+          "schedule": { # The scan is scheduled to run periodically. # The scan is scheduled to run periodically.
+            "cron": "A String", # Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". This field is required for Schedule scans.
+          },
+        },
+      },
+      "labels": { # Optional. User-defined labels for the scan.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+      "state": "A String", # Output only. Current state of the DataScan.
+      "type": "A String", # Output only. The type of DataScan.
+      "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time when the scan was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Update the dataScan resource.
+
+Args:
+  name: string, Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a user-visible job which provides the insights for the related data source. For examples: - Data Quality: generates queries based on the rules and run against the data to get data quality check results. - Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
+  "createTime": "A String", # Output only. The time when the scan was created.
+  "data": { # The data source for DataScan. # Required. The data source for DataScan.
+    "entity": "A String", # Immutable. The dataplex entity that contains the data for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
+  },
+  "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+    "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+      "fields": [ # The sequence of fields describing data in table entities.
+        { # Represents a column field within a table schema.
+          "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+          "name": "A String", # The name of the field.
+          "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+            "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+            "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+              "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                3.14,
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+              "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                "A String",
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+            "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+              "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+              "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+              "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+            },
+            "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+              { # The TopNValue defines the structure of output of top N values of a field.
+                "count": "A String", # The frequency count of the corresponding value in the field.
+                "value": "A String", # The value is the string value of the actual value from the field.
+              },
+            ],
+          },
+          "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+        },
+      ],
+    },
+    "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting.
+  },
+  "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+    "dimensions": [ # A list of results at the dimension-level.
+      { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+        "passed": True or False, # Whether the dimension passed or failed.
+      },
+    ],
+    "passed": True or False, # Overall data quality result -- true if all rules passed.
+    "rowCount": "A String", # The count of rows processed.
+    "rules": [ # A list of all the rules in a job, and their results.
+      { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+        "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+        "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+        "nullCount": "A String", # The number of rows with null values in the specified column.
+        "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+        "passed": True or False, # Whether the rule passed or failed.
+        "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+        "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+          "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+          "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+          "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+          "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+          },
+          "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+            "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+            "regex": "A String",
+          },
+          "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+            "sqlExpression": "A String",
+          },
+          "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+            "values": [
+              "A String",
+            ],
+          },
+          "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+            "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "statistic": "A String",
+            "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+            "sqlExpression": "A String",
+          },
+          "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+          "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+          },
+        },
+      },
+    ],
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting.
+    "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+      { # A rule captures data quality intent about a data source.
+        "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+        "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+        "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+        "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+        },
+        "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+          "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+          "regex": "A String",
+        },
+        "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+          "sqlExpression": "A String",
+        },
+        "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+          "values": [
+            "A String",
+          ],
+        },
+        "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+          "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "statistic": "A String",
+          "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+          "sqlExpression": "A String",
+        },
+        "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+        "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. Description of the scan. * Must be between 1-1024 characters.
+  "displayName": "A String", # Optional. User friendly display name. * Must be between 1-256 characters.
+  "executionSpec": { # DataScan execution settings. # Optional. DataScan execution settings. If not specified, the fields under it will use their default values.
+    "field": "A String", # Immutable. The unnested field (Date or Timestamp) that contains values that monotonically increase over time.
+    "trigger": { # DataScan scheduling and trigger settings. # Optional. Spec related to how often and when a scan should be triggered. If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.
+      "onDemand": { # The scan runs one-time via RunDataScan API. # The scan runs one-time shortly after DataScan Creation.
+      },
+      "schedule": { # The scan is scheduled to run periodically. # The scan is scheduled to run periodically.
+        "cron": "A String", # Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". This field is required for Schedule scans.
+      },
+    },
+  },
+  "labels": { # Optional. User-defined labels for the scan.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+  "state": "A String", # Output only. Current state of the DataScan.
+  "type": "A String", # Output only. The type of DataScan.
+  "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
+  "updateTime": "A String", # Output only. The time when the scan was last updated.
+}
+
+  updateMask: string, Required. Mask of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ run(name, body=None, x__xgafv=None) + 
Run an on demand execution of a DataScan.
+
+Args:
+  name: string, Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region. Only on-demand DataScans are allowed. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Run DataScan Request
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Run DataScan Response.
+  "job": { # A DataScanJob represents an instance of a data scan. # DataScanJob created by RunDataScan API.
+    "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+      "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+        "fields": [ # The sequence of fields describing data in table entities.
+          { # Represents a column field within a table schema.
+            "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+            "name": "A String", # The name of the field.
+            "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+              "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+              "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+                "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                  3.14,
+                ],
+                "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              },
+              "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+                "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                  "A String",
+                ],
+                "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              },
+              "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+              "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+                "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+                "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+                "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+              },
+              "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+                { # The TopNValue defines the structure of output of top N values of a field.
+                  "count": "A String", # The frequency count of the corresponding value in the field.
+                  "value": "A String", # The value is the string value of the actual value from the field.
+                },
+              ],
+            },
+            "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+          },
+        ],
+      },
+      "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+      "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+        "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+          "end": "A String", # Value that marks the end of the range
+          "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+          "start": "A String", # Value that marks the start of the range
+        },
+      },
+    },
+    "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting.
+    },
+    "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+      "dimensions": [ # A list of results at the dimension-level.
+        { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+          "passed": True or False, # Whether the dimension passed or failed.
+        },
+      ],
+      "passed": True or False, # Overall data quality result -- true if all rules passed.
+      "rowCount": "A String", # The count of rows processed.
+      "rules": [ # A list of all the rules in a job, and their results.
+        { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+          "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+          "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+          "nullCount": "A String", # The number of rows with null values in the specified column.
+          "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+          "passed": True or False, # Whether the rule passed or failed.
+          "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+          "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+            "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+            "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+            "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+            "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+            },
+            "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+              "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+              "regex": "A String",
+            },
+            "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+              "sqlExpression": "A String",
+            },
+            "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+              "values": [
+                "A String",
+              ],
+            },
+            "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+              "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "statistic": "A String",
+              "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+              "sqlExpression": "A String",
+            },
+            "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+            "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+            },
+          },
+        },
+      ],
+      "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+        "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+          "end": "A String", # Value that marks the end of the range
+          "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+          "start": "A String", # Value that marks the start of the range
+        },
+      },
+    },
+    "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting.
+      "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+        { # A rule captures data quality intent about a data source.
+          "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+          "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+          "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+          "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+          },
+          "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+            "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+            "regex": "A String",
+          },
+          "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+            "sqlExpression": "A String",
+          },
+          "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+            "values": [
+              "A String",
+            ],
+          },
+          "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+            "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "statistic": "A String",
+            "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+            "sqlExpression": "A String",
+          },
+          "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+          "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+          },
+        },
+      ],
+    },
+    "endTime": "A String", # Output only. The time when the DataScanJob ended.
+    "message": "A String", # Output only. Additional information about the current state.
+    "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+    "startTime": "A String", # Output only. The time when the DataScanJob was started.
+    "state": "A String", # Output only. Execution state for the DataScanJob.
+    "type": "A String", # Output only. The type of the parent DataScan.
+    "uid": "A String", # Output only. System generated globally unique ID for the DataScanJob.
+  },
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+      { # Associates members, or principals, with a role.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) + 
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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html new file mode 100644 index 00000000000..633a2d5f083 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -0,0 +1,487 @@ + + + +

Cloud Dataplex API . projects . locations . dataScans . jobs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, view=None, x__xgafv=None)

+

Get DataScanJob resource.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists DataScanJobs under the given dataScan.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, view=None, x__xgafv=None) + 
Get DataScanJob resource.
+
+Args:
+  name: string, Required. The resource name of the DataScanJob: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  view: string, Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.
+    Allowed values
+      DATA_SCAN_JOB_VIEW_UNSPECIFIED - The API will default to the BASIC view.
+      BASIC - Basic view that does not include spec and result.
+      FULL - Include everything.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A DataScanJob represents an instance of a data scan.
+  "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+    "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+      "fields": [ # The sequence of fields describing data in table entities.
+        { # Represents a column field within a table schema.
+          "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+          "name": "A String", # The name of the field.
+          "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+            "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+            "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+              "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                3.14,
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+              "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+              "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                "A String",
+              ],
+              "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+            },
+            "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+            "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+              "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+              "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+              "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+            },
+            "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+              { # The TopNValue defines the structure of output of top N values of a field.
+                "count": "A String", # The frequency count of the corresponding value in the field.
+                "value": "A String", # The value is the string value of the actual value from the field.
+              },
+            ],
+          },
+          "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+        },
+      ],
+    },
+    "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting.
+  },
+  "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+    "dimensions": [ # A list of results at the dimension-level.
+      { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+        "passed": True or False, # Whether the dimension passed or failed.
+      },
+    ],
+    "passed": True or False, # Overall data quality result -- true if all rules passed.
+    "rowCount": "A String", # The count of rows processed.
+    "rules": [ # A list of all the rules in a job, and their results.
+      { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+        "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+        "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+        "nullCount": "A String", # The number of rows with null values in the specified column.
+        "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+        "passed": True or False, # Whether the rule passed or failed.
+        "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+        "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+          "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+          "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+          "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+          "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+          },
+          "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+            "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+            "regex": "A String",
+          },
+          "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+            "sqlExpression": "A String",
+          },
+          "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+            "values": [
+              "A String",
+            ],
+          },
+          "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+            "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+            "statistic": "A String",
+            "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+            "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+          },
+          "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+            "sqlExpression": "A String",
+          },
+          "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+          "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+          },
+        },
+      },
+    ],
+    "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+      "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+        "end": "A String", # Value that marks the end of the range
+        "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+        "start": "A String", # Value that marks the start of the range
+      },
+    },
+  },
+  "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting.
+    "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+      { # A rule captures data quality intent about a data source.
+        "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+        "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+        "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+        "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+        },
+        "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+          "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+          "regex": "A String",
+        },
+        "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+          "sqlExpression": "A String",
+        },
+        "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+          "values": [
+            "A String",
+          ],
+        },
+        "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+          "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+          "statistic": "A String",
+          "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+          "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+        },
+        "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+          "sqlExpression": "A String",
+        },
+        "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+        "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+        },
+      },
+    ],
+  },
+  "endTime": "A String", # Output only. The time when the DataScanJob ended.
+  "message": "A String", # Output only. Additional information about the current state.
+  "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+  "startTime": "A String", # Output only. The time when the DataScanJob was started.
+  "state": "A String", # Output only. Execution state for the DataScanJob.
+  "type": "A String", # Output only. The type of the parent DataScan.
+  "uid": "A String", # Output only. System generated globally unique ID for the DataScanJob.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists DataScanJobs under the given dataScan.
+
+Args:
+  parent: string, Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  pageSize: integer, Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List DataScanJobs response.
+  "dataScanJobs": [ # DataScanJobs (metadata only) under a given dataScan.
+    { # A DataScanJob represents an instance of a data scan.
+      "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
+        "profile": { # Profile information describing the structure and layout of the data and contains the profile info. # This represents the profile information per field.
+          "fields": [ # The sequence of fields describing data in table entities.
+            { # Represents a column field within a table schema.
+              "mode": "A String", # The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
+              "name": "A String", # The name of the field.
+              "profile": { # ProfileInfo defines the profile information for each schema field type. # The profile information for the corresponding field.
+                "distinctRatio": 3.14, # The ratio of rows that are distinct against the rows in the sampled data.
+                "doubleProfile": { # DoubleFieldInfo defines output for any double type field. # The corresponding double field profile.
+                  "average": 3.14, # The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "max": 3.14, # The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "min": 3.14, # The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "quartiles": [ # A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                    3.14,
+                  ],
+                  "standardDeviation": 3.14, # The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                },
+                "integerProfile": { # IntegerFieldInfo defines output for any integer type field. # The corresponding integer field profile.
+                  "average": 3.14, # The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "max": "A String", # The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "min": "A String", # The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                  "quartiles": [ # A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.
+                    "A String",
+                  ],
+                  "standardDeviation": 3.14, # The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.
+                },
+                "nullRatio": 3.14, # The ratio of null rows against the rows in the sampled data.
+                "stringProfile": { # StringFieldInfo defines output info for any string type field. # The corresponding string field profile.
+                  "averageLength": 3.14, # The average length of a string field in the sampled data. Optional if zero non-null rows.
+                  "maxLength": "A String", # The maximum length of a string field in the sampled data. Optional if zero non-null rows.
+                  "minLength": "A String", # The minimum length of the string field in the sampled data. Optional if zero non-null rows.
+                },
+                "topNValues": [ # The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
+                  { # The TopNValue defines the structure of output of top N values of a field.
+                    "count": "A String", # The frequency count of the corresponding value in the field.
+                    "value": "A String", # The value is the string value of the actual value from the field.
+                  },
+                ],
+              },
+              "type": "A String", # The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD
+            },
+          ],
+        },
+        "rowCount": "A String", # The count of all rows in the sampled data. Return 0, if zero rows.
+        "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this profile.
+          "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+            "end": "A String", # Value that marks the end of the range
+            "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+            "start": "A String", # Value that marks the start of the range
+          },
+        },
+      },
+      "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting.
+      },
+      "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
+        "dimensions": [ # A list of results at the dimension-level.
+          { # DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
+            "passed": True or False, # Whether the dimension passed or failed.
+          },
+        ],
+        "passed": True or False, # Overall data quality result -- true if all rules passed.
+        "rowCount": "A String", # The count of rows processed.
+        "rules": [ # A list of all the rules in a job, and their results.
+          { # DataQualityRuleResult provides a more detailed, per-rule level view of the results.
+            "evaluatedCount": "A String", # The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
+            "failingRowsQuery": "A String", # The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
+            "nullCount": "A String", # The number of rows with null values in the specified column.
+            "passRatio": 3.14, # The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
+            "passed": True or False, # Whether the rule passed or failed.
+            "passedCount": "A String", # The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
+            "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is.
+              "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+              "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+              "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+              "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+              },
+              "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+                "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+                "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+              },
+              "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+                "regex": "A String",
+              },
+              "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+                "sqlExpression": "A String",
+              },
+              "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+                "values": [
+                  "A String",
+                ],
+              },
+              "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+                "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+                "statistic": "A String",
+                "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+                "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+              },
+              "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+                "sqlExpression": "A String",
+              },
+              "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+              "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+              },
+            },
+          },
+        ],
+        "scannedData": { # The data scanned during processing (e.g. in incremental DataScan) # The data scanned for this result.
+          "incrementalField": { # A data range denoted by a pair of start/end values of a field. # The range denoted by values of an incremental field
+            "end": "A String", # Value that marks the end of the range
+            "field": "A String", # The field that contains values which monotonically increases over time (e.g. timestamp).
+            "start": "A String", # Value that marks the start of the range
+          },
+        },
+      },
+      "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting.
+        "rules": [ # The list of rules to evaluate against a data source. At least one rule is required.
+          { # A rule captures data quality intent about a data source.
+            "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+            "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+            "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
+            "nonNullExpectation": { # Evaluates whether each column value is null. # ColumnMap rule which evaluates whether each column value is null.
+            },
+            "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # ColumnMap rule which evaluates whether each column value lies between a specified range.
+              "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "regexExpectation": { # Evaluates whether each column value matches a specified regex. # ColumnMap rule which evaluates whether each column value matches a specified regex.
+              "regex": "A String",
+            },
+            "rowConditionExpectation": { # Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10 # Table rule which evaluates whether each row passes the specified condition.
+              "sqlExpression": "A String",
+            },
+            "setExpectation": { # Evaluates whether each column value is contained by a specified set. # ColumnMap rule which evaluates whether each column value is contained by a specified set.
+              "values": [
+                "A String",
+              ],
+            },
+            "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+              "maxValue": "A String", # The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "minValue": "A String", # The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+              "statistic": "A String",
+              "strictMaxEnabled": True or False, # Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.
+              "strictMinEnabled": True or False, # Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.
+            },
+            "tableConditionExpectation": { # Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0 # Table rule which evaluates whether the provided expression is true.
+              "sqlExpression": "A String",
+            },
+            "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0
+            "uniquenessExpectation": { # Evaluates whether the column has duplicates. # ColumnAggregate rule which evaluates whether the column has duplicates.
+            },
+          },
+        ],
+      },
+      "endTime": "A String", # Output only. The time when the DataScanJob ended.
+      "message": "A String", # Output only. Additional information about the current state.
+      "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
+      "startTime": "A String", # Output only. The time when the DataScanJob was started.
+      "state": "A String", # Output only. Execution state for the DataScanJob.
+      "type": "A String", # Output only. The type of the parent DataScan.
+      "uid": "A String", # Output only. System generated globally unique ID for the DataScanJob.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html new file mode 100644 index 00000000000..e7af2094265 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . dataTaxonomies . attributes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

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

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

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

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

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.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+      { # Associates members, or principals, with a role.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) + 
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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html new file mode 100644 index 00000000000..c6516fb3950 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html @@ -0,0 +1,263 @@ + + + +

Cloud Dataplex API . projects . locations . dataTaxonomies

+

Instance Methods

+

+ attributes() +

+

Returns the attributes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

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

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

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

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

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.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+      { # Associates members, or principals, with a role.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+      },
+    ],
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+    "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+    { # Associates members, or principals, with a role.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.
+    },
+  ],
+  "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+  "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) + 
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.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+  "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for TestIamPermissions method.
+  "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index bf1f26a3d0e..d46c36e7e3f 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -74,6 +74,21 @@

Cloud Dataplex API . projects . locations

Instance Methods

+

+ dataAttributeBindings() +

+

Returns the dataAttributeBindings Resource.

+ +

+ dataScans() +

+

Returns the dataScans Resource.

+ +

+ dataTaxonomies() +

+

Returns the dataTaxonomies Resource.

+

lakes()

diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 9cd0477fdd1..2923b14c539 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -177,38 +177,124 @@ } }, "resources": { - "lakes": { + "dataAttributeBindings": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.projects.locations.dataAttributeBindings.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataAttributeBindings.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataAttributeBindings.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "dataScans": { "methods": { "create": { - "description": "Creates a lake resource.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes", + "description": "Creates a dataScan resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans", "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.create", + "id": "dataplex.projects.locations.dataScans.create", "parameterOrder": [ "parent" ], "parameters": { - "lakeId": { - "description": "Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.", + "dataScanId": { + "description": "Required. DataScan identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the parent location: projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", - "location": "query", - "type": "boolean" } }, - "path": "v1/{+parent}/lakes", + "path": "v1/{+parent}/dataScans", "request": { - "$ref": "GoogleCloudDataplexV1Lake" + "$ref": "GoogleCloudDataplexV1DataScan" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -218,18 +304,18 @@ ] }, "delete": { - "description": "Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "description": "Delete the dataScan resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}", "httpMethod": "DELETE", - "id": "dataplex.projects.locations.lakes.delete", + "id": "dataplex.projects.locations.dataScans.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "description": "Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } @@ -243,25 +329,40 @@ ] }, "get": { - "description": "Retrieves a lake resource.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "description": "Get dataScan resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}", "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.get", + "id": "dataplex.projects.locations.dataScans.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "description": "Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.", + "enum": [ + "DATA_SCAN_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The API will default to the BASIC view.", + "Basic view that does not include spec and result.", + "Include everything." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudDataplexV1Lake" + "$ref": "GoogleCloudDataplexV1DataScan" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -269,9 +370,9 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:getIamPolicy", "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.getIamPolicy", + "id": "dataplex.projects.locations.dataScans.getIamPolicy", "parameterOrder": [ "resource" ], @@ -285,7 +386,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } @@ -299,10 +400,10 @@ ] }, "list": { - "description": "Lists lake resources in a project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes", + "description": "Lists dataScans.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans", "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.list", + "id": "dataplex.projects.locations.dataScans.list", "parameterOrder": [ "parent" ], @@ -313,50 +414,50 @@ "type": "string" }, "orderBy": { - "description": "Optional. Order by fields for the result.", + "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 10 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListLakes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakes must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/lakes", + "path": "v1/{+parent}/dataScans", "response": { - "$ref": "GoogleCloudDataplexV1ListLakesResponse" + "$ref": "GoogleCloudDataplexV1ListDataScansResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates a lake resource.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "description": "Update the dataScan resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}", "httpMethod": "PATCH", - "id": "dataplex.projects.locations.lakes.patch", + "id": "dataplex.projects.locations.dataScans.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "description": "Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" }, @@ -365,16 +466,11 @@ "format": "google-fieldmask", "location": "query", "type": "string" - }, - "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", - "location": "query", - "type": "boolean" } }, "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudDataplexV1Lake" + "$ref": "GoogleCloudDataplexV1DataScan" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -383,11 +479,39 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "run": { + "description": "Run an on demand execution of a DataScan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:run", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataScans.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region. Only on-demand DataScans are allowed.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:run", + "request": { + "$ref": "GoogleCloudDataplexV1RunDataScanRequest" + }, + "response": { + "$ref": "GoogleCloudDataplexV1RunDataScanResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:setIamPolicy", "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.setIamPolicy", + "id": "dataplex.projects.locations.dataScans.setIamPolicy", "parameterOrder": [ "resource" ], @@ -395,7 +519,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } @@ -413,9 +537,9 @@ }, "testIamPermissions": { "description": "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:testIamPermissions", "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.testIamPermissions", + "id": "dataplex.projects.locations.dataScans.testIamPermissions", "parameterOrder": [ "resource" ], @@ -423,7 +547,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } @@ -441,151 +565,186 @@ } }, "resources": { - "actions": { + "jobs": { "methods": { - "list": { - "description": "Lists action resources in a lake.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions", + "get": { + "description": "Get DataScanJob resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}", "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.actions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/actions", - "response": { - "$ref": "GoogleCloudDataplexV1ListActionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "content": { - "methods": { - "create": { - "description": "Create a content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", - "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.content.create", + "id": "dataplex.projects.locations.dataScans.jobs.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", + "name": { + "description": "Required. The resource name of the DataScanJob: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$", "required": true, "type": "string" }, - "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "view": { + "description": "Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.", + "enum": [ + "DATA_SCAN_JOB_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The API will default to the BASIC view.", + "Basic view that does not include spec and result.", + "Include everything." + ], "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "v1/{+parent}/content", - "request": { - "$ref": "GoogleCloudDataplexV1Content" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudDataplexV1Content" + "$ref": "GoogleCloudDataplexV1DataScanJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Delete a content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", - "httpMethod": "DELETE", - "id": "dataplex.projects.locations.lakes.content.delete", + "list": { + "description": "Lists DataScanJobs under the given dataScan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs", + "httpMethod": "GET", + "id": "dataplex.projects.locations.dataScans.jobs.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", + "pageSize": { + "description": "Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/jobs", "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get a content resource.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", - "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.content.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", - "required": true, - "type": "string" - }, - "view": { - "description": "Optional. Specify content view to make a partial request.", - "enum": [ - "CONTENT_VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "Content view not specified. Defaults to BASIC. The API will default to the BASIC view.", - "Will not return the data_text field.", - "Returns the complete proto." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudDataplexV1Content" + "$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "dataTaxonomies": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.projects.locations.dataTaxonomies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataTaxonomies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataTaxonomies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "attributes": { + "methods": { "getIamPolicy": { - "description": "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:getIamPolicy", + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy", "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.content.getIamPolicy", + "id": "dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy", "parameterOrder": [ "resource" ], @@ -599,7 +758,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", "required": true, "type": "string" } @@ -612,91 +771,11 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "List content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", - "httpMethod": "GET", - "id": "dataplex.projects.locations.lakes.content.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 type = \"NOTEBOOK\" type = \"SQL_SCRIPT\"These restrictions can be coinjoined with AND, OR and NOT conjunctions.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/content", - "response": { - "$ref": "GoogleCloudDataplexV1ListContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Update a content. Only supports full resource update.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", - "httpMethod": "PATCH", - "id": "dataplex.projects.locations.lakes.content.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Mask of fields to update.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudDataplexV1Content" - }, - "response": { - "$ref": "GoogleCloudDataplexV1Content" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { - "description": "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy", + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:setIamPolicy", "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.content.setIamPolicy", + "id": "dataplex.projects.locations.dataTaxonomies.attributes.setIamPolicy", "parameterOrder": [ "resource" ], @@ -704,7 +783,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", "required": true, "type": "string" } @@ -721,10 +800,10 @@ ] }, "testIamPermissions": { - "description": "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.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions", + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:testIamPermissions", "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.content.testIamPermissions", + "id": "dataplex.projects.locations.dataTaxonomies.attributes.testIamPermissions", "parameterOrder": [ "resource" ], @@ -732,7 +811,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", "required": true, "type": "string" } @@ -749,45 +828,620 @@ ] } } - }, - "contentitems": { - "methods": { - "create": { - "description": "Create a content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems", - "httpMethod": "POST", - "id": "dataplex.projects.locations.lakes.contentitems.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", - "required": true, - "type": "string" - }, - "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+parent}/contentitems", - "request": { - "$ref": "GoogleCloudDataplexV1Content" - }, - "response": { - "$ref": "GoogleCloudDataplexV1Content" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Delete a content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}", + } + } + }, + "lakes": { + "methods": { + "create": { + "description": "Creates a lake resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "lakeId": { + "description": "Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/lakes", + "request": { + "$ref": "GoogleCloudDataplexV1Lake" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.lakes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a lake resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1Lake" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists lake resources in a project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListLakes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakes must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/lakes", + "response": { + "$ref": "GoogleCloudDataplexV1ListLakesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a lake resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.lakes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1Lake" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "actions": { + "methods": { + "list": { + "description": "Lists action resources in a lake.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.actions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/actions", + "response": { + "$ref": "GoogleCloudDataplexV1ListActionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "content": { + "methods": { + "create": { + "description": "Create a content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.content.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/content", + "request": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "response": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.lakes.content.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a content resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.content.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Specify content view to make a partial request.", + "enum": [ + "CONTENT_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "Content view not specified. Defaults to BASIC. The API will default to the BASIC view.", + "Will not return the data_text field.", + "Returns the complete proto." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.content.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lakes.content.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 type = \"NOTEBOOK\" type = \"SQL_SCRIPT\"These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/content", + "response": { + "$ref": "GoogleCloudDataplexV1ListContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a content. Only supports full resource update.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.lakes.content.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "response": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.content.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.content.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "contentitems": { + "methods": { + "create": { + "description": "Create a content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems", + "httpMethod": "POST", + "id": "dataplex.projects.locations.lakes.contentitems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/contentitems", + "request": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "response": { + "$ref": "GoogleCloudDataplexV1Content" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.lakes.contentitems.delete", "parameterOrder": [ @@ -2764,7 +3418,7 @@ } } }, - "revision": "20221103", + "revision": "20221113", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -2782,607 +3436,1226 @@ "readOnly": true, "type": "string" }, - "category": { - "description": "The category of issue associated with the action.", + "category": { + "description": "The category of issue associated with the action.", + "enum": [ + "CATEGORY_UNSPECIFIED", + "RESOURCE_MANAGEMENT", + "SECURITY_POLICY", + "DATA_DISCOVERY" + ], + "enumDescriptions": [ + "Unspecified category.", + "Resource management related issues.", + "Security policy related issues.", + "Data and discovery related issues." + ], + "type": "string" + }, + "dataLocations": { + "description": "The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id).", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectTime": { + "description": "The time that the issue was detected.", + "format": "google-datetime", + "type": "string" + }, + "failedSecurityPolicyApply": { + "$ref": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply", + "description": "Details for issues related to applying security policy." + }, + "incompatibleDataSchema": { + "$ref": "GoogleCloudDataplexV1ActionIncompatibleDataSchema", + "description": "Details for issues related to incompatible schemas detected within data." + }, + "invalidDataFormat": { + "$ref": "GoogleCloudDataplexV1ActionInvalidDataFormat", + "description": "Details for issues related to invalid or unsupported data formats." + }, + "invalidDataOrganization": { + "$ref": "GoogleCloudDataplexV1ActionInvalidDataOrganization", + "description": "Details for issues related to invalid data arrangement." + }, + "invalidDataPartition": { + "$ref": "GoogleCloudDataplexV1ActionInvalidDataPartition", + "description": "Details for issues related to invalid or unsupported data partition structure." + }, + "issue": { + "description": "Detailed description of the issue requiring action.", + "type": "string" + }, + "lake": { + "description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", + "readOnly": true, + "type": "string" + }, + "missingData": { + "$ref": "GoogleCloudDataplexV1ActionMissingData", + "description": "Details for issues related to absence of data within managed resources." + }, + "missingResource": { + "$ref": "GoogleCloudDataplexV1ActionMissingResource", + "description": "Details for issues related to absence of a managed resource." + }, + "name": { + "description": "Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}.", + "readOnly": true, + "type": "string" + }, + "unauthorizedResource": { + "$ref": "GoogleCloudDataplexV1ActionUnauthorizedResource", + "description": "Details for issues related to lack of permissions to access data resources." + }, + "zone": { + "description": "Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply": { + "description": "Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource.", + "id": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply", + "properties": { + "asset": { + "description": "Resource name of one of the assets with failing security policy application. Populated for a lake or zone resource only.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ActionIncompatibleDataSchema": { + "description": "Action details for incompatible schemas detected by discovery.", + "id": "GoogleCloudDataplexV1ActionIncompatibleDataSchema", + "properties": { + "existingSchema": { + "description": "The existing and expected schema of the table. The schema is provided as a JSON formatted structure listing columns and data types.", + "type": "string" + }, + "newSchema": { + "description": "The new and incompatible schema within the table. The schema is provided as a JSON formatted structured listing columns and data types.", + "type": "string" + }, + "sampledDataLocations": { + "description": "The list of data locations sampled and used for format/schema inference.", + "items": { + "type": "string" + }, + "type": "array" + }, + "schemaChange": { + "description": "Whether the action relates to a schema that is incompatible or modified.", + "enum": [ + "SCHEMA_CHANGE_UNSPECIFIED", + "INCOMPATIBLE", + "MODIFIED" + ], + "enumDescriptions": [ + "Schema change unspecified.", + "Newly discovered schema is incompatible with existing schema.", + "Newly discovered schema has changed from existing schema for data in a curated zone." + ], + "type": "string" + }, + "table": { + "description": "The name of the table containing invalid data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ActionInvalidDataFormat": { + "description": "Action details for invalid or unsupported data files detected by discovery.", + "id": "GoogleCloudDataplexV1ActionInvalidDataFormat", + "properties": { + "expectedFormat": { + "description": "The expected data format of the entity.", + "type": "string" + }, + "newFormat": { + "description": "The new unexpected data format within the entity.", + "type": "string" + }, + "sampledDataLocations": { + "description": "The list of data locations sampled and used for format/schema inference.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ActionInvalidDataOrganization": { + "description": "Action details for invalid data arrangement.", + "id": "GoogleCloudDataplexV1ActionInvalidDataOrganization", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1ActionInvalidDataPartition": { + "description": "Action details for invalid or unsupported partitions detected by discovery.", + "id": "GoogleCloudDataplexV1ActionInvalidDataPartition", + "properties": { + "expectedStructure": { + "description": "The issue type of InvalidDataPartition.", + "enum": [ + "PARTITION_STRUCTURE_UNSPECIFIED", + "CONSISTENT_KEYS", + "HIVE_STYLE_KEYS" + ], + "enumDescriptions": [ + "PartitionStructure unspecified.", + "Consistent hive-style partition definition (both raw and curated zone).", + "Hive style partition definition (curated zone only)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ActionMissingData": { + "description": "Action details for absence of data detected by discovery.", + "id": "GoogleCloudDataplexV1ActionMissingData", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1ActionMissingResource": { + "description": "Action details for resource references in assets that cannot be located.", + "id": "GoogleCloudDataplexV1ActionMissingResource", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1ActionUnauthorizedResource": { + "description": "Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset.", + "id": "GoogleCloudDataplexV1ActionUnauthorizedResource", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1Asset": { + "description": "An asset represents a cloud resource that is being managed within a lake as a member of a zone.", + "id": "GoogleCloudDataplexV1Asset", + "properties": { + "createTime": { + "description": "Output only. The time when the asset was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the asset.", + "type": "string" + }, + "discoverySpec": { + "$ref": "GoogleCloudDataplexV1AssetDiscoverySpec", + "description": "Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone." + }, + "discoveryStatus": { + "$ref": "GoogleCloudDataplexV1AssetDiscoveryStatus", + "description": "Output only. Status of the discovery feature applied to data referenced by this asset.", + "readOnly": true + }, + "displayName": { + "description": "Optional. User friendly display name.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User defined labels for the asset.", + "type": "object" + }, + "name": { + "description": "Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.", + "readOnly": true, + "type": "string" + }, + "resourceSpec": { + "$ref": "GoogleCloudDataplexV1AssetResourceSpec", + "description": "Required. Specification of the resource that is referenced by this asset." + }, + "resourceStatus": { + "$ref": "GoogleCloudDataplexV1AssetResourceStatus", + "description": "Output only. Status of the resource referenced by this asset.", + "readOnly": true + }, + "securityStatus": { + "$ref": "GoogleCloudDataplexV1AssetSecurityStatus", + "description": "Output only. Status of the security policy applied to resource referenced by this asset.", + "readOnly": true + }, + "state": { + "description": "Output only. Current state of the asset.", "enum": [ - "CATEGORY_UNSPECIFIED", - "RESOURCE_MANAGEMENT", - "SECURITY_POLICY", - "DATA_DISCOVERY" + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "ACTION_REQUIRED" ], "enumDescriptions": [ - "Unspecified category.", - "Resource management related issues.", - "Security policy related issues.", - "Data and discovery related issues." + "State is not specified.", + "Resource is active, i.e., ready to use.", + "Resource is under creation.", + "Resource is under deletion.", + "Resource is active but has unresolved actions." ], + "readOnly": true, "type": "string" }, - "dataLocations": { - "description": "The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id).", - "items": { - "type": "string" - }, - "type": "array" + "uid": { + "description": "Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.", + "readOnly": true, + "type": "string" }, - "detectTime": { - "description": "The time that the issue was detected.", + "updateTime": { + "description": "Output only. The time when the asset was last updated.", "format": "google-datetime", + "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AssetDiscoverySpec": { + "description": "Settings to manage the metadata discovery and publishing for an asset.", + "id": "GoogleCloudDataplexV1AssetDiscoverySpec", + "properties": { + "csvOptions": { + "$ref": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions", + "description": "Optional. Configuration for CSV data." }, - "failedSecurityPolicyApply": { - "$ref": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply", - "description": "Details for issues related to applying security policy." - }, - "incompatibleDataSchema": { - "$ref": "GoogleCloudDataplexV1ActionIncompatibleDataSchema", - "description": "Details for issues related to incompatible schemas detected within data." + "enabled": { + "description": "Optional. Whether discovery is enabled.", + "type": "boolean" }, - "invalidDataFormat": { - "$ref": "GoogleCloudDataplexV1ActionInvalidDataFormat", - "description": "Details for issues related to invalid or unsupported data formats." + "excludePatterns": { + "description": "Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.", + "items": { + "type": "string" + }, + "type": "array" }, - "invalidDataOrganization": { - "$ref": "GoogleCloudDataplexV1ActionInvalidDataOrganization", - "description": "Details for issues related to invalid data arrangement." + "includePatterns": { + "description": "Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.", + "items": { + "type": "string" + }, + "type": "array" }, - "invalidDataPartition": { - "$ref": "GoogleCloudDataplexV1ActionInvalidDataPartition", - "description": "Details for issues related to invalid or unsupported data partition structure." + "jsonOptions": { + "$ref": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions", + "description": "Optional. Configuration for Json data." }, - "issue": { - "description": "Detailed description of the issue requiring action.", + "schedule": { + "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", "type": "string" - }, - "lake": { - "description": "Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", - "readOnly": true, + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions": { + "description": "Describe CSV and similar semi-structured data formats.", + "id": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions", + "properties": { + "delimiter": { + "description": "Optional. The delimiter being used to separate values. This defaults to ','.", "type": "string" }, - "missingData": { - "$ref": "GoogleCloudDataplexV1ActionMissingData", - "description": "Details for issues related to absence of data within managed resources." - }, - "missingResource": { - "$ref": "GoogleCloudDataplexV1ActionMissingResource", - "description": "Details for issues related to absence of a managed resource." + "disableTypeInference": { + "description": "Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.", + "type": "boolean" }, - "name": { - "description": "Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}.", - "readOnly": true, + "encoding": { + "description": "Optional. The character encoding of the data. The default is UTF-8.", "type": "string" }, - "unauthorizedResource": { - "$ref": "GoogleCloudDataplexV1ActionUnauthorizedResource", - "description": "Details for issues related to lack of permissions to access data resources." - }, - "zone": { - "description": "Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.", - "readOnly": true, - "type": "string" + "headerRows": { + "description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply": { - "description": "Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource.", - "id": "GoogleCloudDataplexV1ActionFailedSecurityPolicyApply", + "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions": { + "description": "Describe JSON data format.", + "id": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions", "properties": { - "asset": { - "description": "Resource name of one of the assets with failing security policy application. Populated for a lake or zone resource only.", + "disableTypeInference": { + "description": "Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).", + "type": "boolean" + }, + "encoding": { + "description": "Optional. The character encoding of the data. The default is UTF-8.", "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1ActionIncompatibleDataSchema": { - "description": "Action details for incompatible schemas detected by discovery.", - "id": "GoogleCloudDataplexV1ActionIncompatibleDataSchema", + "GoogleCloudDataplexV1AssetDiscoveryStatus": { + "description": "Status of discovery for an asset.", + "id": "GoogleCloudDataplexV1AssetDiscoveryStatus", "properties": { - "existingSchema": { - "description": "The existing and expected schema of the table. The schema is provided as a JSON formatted structure listing columns and data types.", + "lastRunDuration": { + "description": "The duration of the last discovery run.", + "format": "google-duration", "type": "string" }, - "newSchema": { - "description": "The new and incompatible schema within the table. The schema is provided as a JSON formatted structured listing columns and data types.", + "lastRunTime": { + "description": "The start time of the last discovery run.", + "format": "google-datetime", "type": "string" }, - "sampledDataLocations": { - "description": "The list of data locations sampled and used for format/schema inference.", - "items": { - "type": "string" - }, - "type": "array" + "message": { + "description": "Additional information about the current state.", + "type": "string" }, - "schemaChange": { - "description": "Whether the action relates to a schema that is incompatible or modified.", + "state": { + "description": "The current status of the discovery feature.", "enum": [ - "SCHEMA_CHANGE_UNSPECIFIED", - "INCOMPATIBLE", - "MODIFIED" + "STATE_UNSPECIFIED", + "SCHEDULED", + "IN_PROGRESS", + "PAUSED", + "DISABLED" ], "enumDescriptions": [ - "Schema change unspecified.", - "Newly discovered schema is incompatible with existing schema.", - "Newly discovered schema has changed from existing schema for data in a curated zone." + "State is unspecified.", + "Discovery for the asset is scheduled.", + "Discovery for the asset is running.", + "Discovery for the asset is currently paused (e.g. due to a lack of available resources). It will be automatically resumed.", + "Discovery for the asset is disabled." ], "type": "string" }, - "table": { - "description": "The name of the table containing invalid data.", + "stats": { + "$ref": "GoogleCloudDataplexV1AssetDiscoveryStatusStats", + "description": "Data Stats of the asset reported by discovery." + }, + "updateTime": { + "description": "Last update time of the status.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AssetDiscoveryStatusStats": { + "description": "The aggregated data statistics for the asset reported by discovery.", + "id": "GoogleCloudDataplexV1AssetDiscoveryStatusStats", + "properties": { + "dataItems": { + "description": "The count of data items within the referenced resource.", + "format": "int64", + "type": "string" + }, + "dataSize": { + "description": "The number of stored data bytes within the referenced resource.", + "format": "int64", + "type": "string" + }, + "filesets": { + "description": "The count of fileset entities within the referenced resource.", + "format": "int64", + "type": "string" + }, + "tables": { + "description": "The count of table entities within the referenced resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AssetResourceSpec": { + "description": "Identifies the cloud resource that is referenced by this asset.", + "id": "GoogleCloudDataplexV1AssetResourceSpec", + "properties": { + "name": { + "description": "Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}", + "type": "string" + }, + "type": { + "description": "Required. Immutable. Type of resource.", + "enum": [ + "TYPE_UNSPECIFIED", + "STORAGE_BUCKET", + "BIGQUERY_DATASET" + ], + "enumDescriptions": [ + "Type not specified.", + "Cloud Storage bucket.", + "BigQuery dataset." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1ActionInvalidDataFormat": { - "description": "Action details for invalid or unsupported data files detected by discovery.", - "id": "GoogleCloudDataplexV1ActionInvalidDataFormat", + "GoogleCloudDataplexV1AssetResourceStatus": { + "description": "Status of the resource referenced by an asset.", + "id": "GoogleCloudDataplexV1AssetResourceStatus", "properties": { - "expectedFormat": { - "description": "The expected data format of the entity.", + "message": { + "description": "Additional information about the current state.", "type": "string" }, - "newFormat": { - "description": "The new unexpected data format within the entity.", + "state": { + "description": "The current state of the managed resource.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "ERROR" + ], + "enumDescriptions": [ + "State unspecified.", + "Resource does not have any errors.", + "Resource has errors." + ], "type": "string" }, - "sampledDataLocations": { - "description": "The list of data locations sampled and used for format/schema inference.", - "items": { - "type": "string" - }, - "type": "array" + "updateTime": { + "description": "Last update time of the status.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1ActionInvalidDataOrganization": { - "description": "Action details for invalid data arrangement.", - "id": "GoogleCloudDataplexV1ActionInvalidDataOrganization", - "properties": {}, - "type": "object" - }, - "GoogleCloudDataplexV1ActionInvalidDataPartition": { - "description": "Action details for invalid or unsupported partitions detected by discovery.", - "id": "GoogleCloudDataplexV1ActionInvalidDataPartition", + "GoogleCloudDataplexV1AssetSecurityStatus": { + "description": "Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.", + "id": "GoogleCloudDataplexV1AssetSecurityStatus", "properties": { - "expectedStructure": { - "description": "The issue type of InvalidDataPartition.", + "message": { + "description": "Additional information about the current state.", + "type": "string" + }, + "state": { + "description": "The current state of the security policy applied to the attached resource.", "enum": [ - "PARTITION_STRUCTURE_UNSPECIFIED", - "CONSISTENT_KEYS", - "HIVE_STYLE_KEYS" + "STATE_UNSPECIFIED", + "READY", + "APPLYING", + "ERROR" ], "enumDescriptions": [ - "PartitionStructure unspecified.", - "Consistent hive-style partition definition (both raw and curated zone).", - "Hive style partition definition (curated zone only)." + "State unspecified.", + "Security policy has been successfully applied to the attached resource.", + "Security policy is in the process of being applied to the attached resource.", + "Security policy could not be applied to the attached resource due to errors." ], "type": "string" + }, + "updateTime": { + "description": "Last update time of the status.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1ActionMissingData": { - "description": "Action details for absence of data detected by discovery.", - "id": "GoogleCloudDataplexV1ActionMissingData", - "properties": {}, - "type": "object" - }, - "GoogleCloudDataplexV1ActionMissingResource": { - "description": "Action details for resource references in assets that cannot be located.", - "id": "GoogleCloudDataplexV1ActionMissingResource", - "properties": {}, + "GoogleCloudDataplexV1AssetStatus": { + "description": "Aggregated status of the underlying assets of a lake or zone.", + "id": "GoogleCloudDataplexV1AssetStatus", + "properties": { + "activeAssets": { + "description": "Number of active assets.", + "format": "int32", + "type": "integer" + }, + "securityPolicyApplyingAssets": { + "description": "Number of assets that are in process of updating the security policy on attached resources.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "Last update time of the status.", + "format": "google-datetime", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDataplexV1ActionUnauthorizedResource": { - "description": "Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset.", - "id": "GoogleCloudDataplexV1ActionUnauthorizedResource", + "GoogleCloudDataplexV1CancelJobRequest": { + "description": "Cancel task jobs.", + "id": "GoogleCloudDataplexV1CancelJobRequest", "properties": {}, "type": "object" }, - "GoogleCloudDataplexV1Asset": { - "description": "An asset represents a cloud resource that is being managed within a lake as a member of a zone.", - "id": "GoogleCloudDataplexV1Asset", + "GoogleCloudDataplexV1Content": { + "description": "Content represents a user-visible notebook or a sql script", + "id": "GoogleCloudDataplexV1Content", "properties": { "createTime": { - "description": "Output only. The time when the asset was created.", + "description": "Output only. Content creation time.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "description": { - "description": "Optional. Description of the asset.", + "dataText": { + "description": "Required. Content data in string format.", "type": "string" }, - "discoverySpec": { - "$ref": "GoogleCloudDataplexV1AssetDiscoverySpec", - "description": "Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone." - }, - "discoveryStatus": { - "$ref": "GoogleCloudDataplexV1AssetDiscoveryStatus", - "description": "Output only. Status of the discovery feature applied to data referenced by this asset.", - "readOnly": true - }, - "displayName": { - "description": "Optional. User friendly display name.", + "description": { + "description": "Optional. Description of the content.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. User defined labels for the asset.", + "description": "Optional. User defined labels for the content.", "type": "object" }, "name": { - "description": "Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.", + "description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", "readOnly": true, "type": "string" }, - "resourceSpec": { - "$ref": "GoogleCloudDataplexV1AssetResourceSpec", - "description": "Required. Specification of the resource that is referenced by this asset." + "notebook": { + "$ref": "GoogleCloudDataplexV1ContentNotebook", + "description": "Notebook related configurations." }, - "resourceStatus": { - "$ref": "GoogleCloudDataplexV1AssetResourceStatus", - "description": "Output only. Status of the resource referenced by this asset.", - "readOnly": true + "path": { + "description": "Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.", + "type": "string" }, - "securityStatus": { - "$ref": "GoogleCloudDataplexV1AssetSecurityStatus", - "description": "Output only. Status of the security policy applied to resource referenced by this asset.", - "readOnly": true + "sqlScript": { + "$ref": "GoogleCloudDataplexV1ContentSqlScript", + "description": "Sql Script related configurations." }, - "state": { - "description": "Output only. Current state of the asset.", + "uid": { + "description": "Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the content was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ContentNotebook": { + "description": "Configuration for Notebook content.", + "id": "GoogleCloudDataplexV1ContentNotebook", + "properties": { + "kernelType": { + "description": "Required. Kernel Type of the notebook.", "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "CREATING", - "DELETING", - "ACTION_REQUIRED" + "KERNEL_TYPE_UNSPECIFIED", + "PYTHON3" ], "enumDescriptions": [ - "State is not specified.", - "Resource is active, i.e., ready to use.", - "Resource is under creation.", - "Resource is under deletion.", - "Resource is active but has unresolved actions." + "Kernel Type unspecified.", + "Python 3 Kernel." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ContentSqlScript": { + "description": "Configuration for the Sql Script content.", + "id": "GoogleCloudDataplexV1ContentSqlScript", + "properties": { + "engine": { + "description": "Required. Query Engine to be used for the Sql Query.", + "enum": [ + "QUERY_ENGINE_UNSPECIFIED", + "SPARK" + ], + "enumDescriptions": [ + "Value was unspecified.", + "Spark SQL Query." ], - "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResult": { + "description": "DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.", + "id": "GoogleCloudDataplexV1DataProfileResult", + "properties": { + "profile": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfile", + "description": "This represents the profile information per field." }, - "uid": { - "description": "Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.", - "readOnly": true, + "rowCount": { + "description": "The count of all rows in the sampled data. Return 0, if zero rows.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Output only. The time when the asset was last updated.", - "format": "google-datetime", - "readOnly": true, + "scannedData": { + "$ref": "GoogleCloudDataplexV1ScannedData", + "description": "The data scanned for this profile." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResultProfile": { + "description": "Profile information describing the structure and layout of the data and contains the profile info.", + "id": "GoogleCloudDataplexV1DataProfileResultProfile", + "properties": { + "fields": { + "description": "The sequence of fields describing data in table entities.", + "items": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileField" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResultProfileField": { + "description": "Represents a column field within a table schema.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileField", + "properties": { + "mode": { + "description": "The mode of the field. Its value will be: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.", + "type": "string" + }, + "name": { + "description": "The name of the field.", "type": "string" + }, + "profile": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", + "description": "The profile information for the corresponding field." + }, + "type": { + "description": "The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo": { + "description": "ProfileInfo defines the profile information for each schema field type.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", + "properties": { + "distinctRatio": { + "description": "The ratio of rows that are distinct against the rows in the sampled data.", + "format": "double", + "type": "number" + }, + "doubleProfile": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo", + "description": "The corresponding double field profile." + }, + "integerProfile": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo", + "description": "The corresponding integer field profile." + }, + "nullRatio": { + "description": "The ratio of null rows against the rows in the sampled data.", + "format": "double", + "type": "number" + }, + "stringProfile": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo", + "description": "The corresponding string field profile." + }, + "topNValues": { + "description": "The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.", + "items": { + "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetDiscoverySpec": { - "description": "Settings to manage the metadata discovery and publishing for an asset.", - "id": "GoogleCloudDataplexV1AssetDiscoverySpec", + "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo": { + "description": "DoubleFieldInfo defines output for any double type field.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo", "properties": { - "csvOptions": { - "$ref": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions", - "description": "Optional. Configuration for CSV data." - }, - "enabled": { - "description": "Optional. Whether discovery is enabled.", - "type": "boolean" - }, - "excludePatterns": { - "description": "Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.", + "average": { + "description": "The average of non-null values of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + }, + "max": { + "description": "The maximum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value of a double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + }, + "quartiles": { + "description": "A quartile divide the numebr of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.", "items": { - "type": "string" + "format": "double", + "type": "number" }, "type": "array" }, - "includePatterns": { - "description": "Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.", + "standardDeviation": { + "description": "The standard deviation of non-null of double field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo": { + "description": "IntegerFieldInfo defines output for any integer type field.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo", + "properties": { + "average": { + "description": "The average of non-null values of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + }, + "max": { + "description": "The maximum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "The minimum value of an integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "int64", + "type": "string" + }, + "quartiles": { + "description": "A quartile divide the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. So, here the quartiles is provided as an ordered list of quartile values, occurring in order Q1, median, Q3.", "items": { + "format": "int64", "type": "string" }, "type": "array" }, - "jsonOptions": { - "$ref": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions", - "description": "Optional. Configuration for Json data." + "standardDeviation": { + "description": "The standard deviation of non-null of integer field in the sampled data. Return NaN, if the field has a NaN. Optional if zero non-null rows.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo": { + "description": "StringFieldInfo defines output info for any string type field.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo", + "properties": { + "averageLength": { + "description": "The average length of a string field in the sampled data. Optional if zero non-null rows.", + "format": "double", + "type": "number" }, - "schedule": { - "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", + "maxLength": { + "description": "The maximum length of a string field in the sampled data. Optional if zero non-null rows.", + "format": "int64", + "type": "string" + }, + "minLength": { + "description": "The minimum length of the string field in the sampled data. Optional if zero non-null rows.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions": { - "description": "Describe CSV and similar semi-structured data formats.", - "id": "GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions", + "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue": { + "description": "The TopNValue defines the structure of output of top N values of a field.", + "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue", "properties": { - "delimiter": { - "description": "Optional. The delimiter being used to separate values. This defaults to ','.", + "count": { + "description": "The frequency count of the corresponding value in the field.", + "format": "int64", "type": "string" }, - "disableTypeInference": { - "description": "Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.", - "type": "boolean" - }, - "encoding": { - "description": "Optional. The character encoding of the data. The default is UTF-8.", + "value": { + "description": "The value is the string value of the actual value from the field.", "type": "string" - }, - "headerRows": { - "description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions": { - "description": "Describe JSON data format.", - "id": "GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions", + "GoogleCloudDataplexV1DataProfileSpec": { + "description": "DataProfileScan related setting.", + "id": "GoogleCloudDataplexV1DataProfileSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityDimensionResult": { + "description": "DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.", + "id": "GoogleCloudDataplexV1DataQualityDimensionResult", "properties": { - "disableTypeInference": { - "description": "Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).", + "passed": { + "description": "Whether the dimension passed or failed.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityResult": { + "description": "The output of a DataQualityScan.", + "id": "GoogleCloudDataplexV1DataQualityResult", + "properties": { + "dimensions": { + "description": "A list of results at the dimension-level.", + "items": { + "$ref": "GoogleCloudDataplexV1DataQualityDimensionResult" + }, + "type": "array" + }, + "passed": { + "description": "Overall data quality result -- true if all rules passed.", "type": "boolean" }, - "encoding": { - "description": "Optional. The character encoding of the data. The default is UTF-8.", + "rowCount": { + "description": "The count of rows processed.", + "format": "int64", "type": "string" + }, + "rules": { + "description": "A list of all the rules in a job, and their results.", + "items": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleResult" + }, + "type": "array" + }, + "scannedData": { + "$ref": "GoogleCloudDataplexV1ScannedData", + "description": "The data scanned for this result." } }, "type": "object" }, - "GoogleCloudDataplexV1AssetDiscoveryStatus": { - "description": "Status of discovery for an asset.", - "id": "GoogleCloudDataplexV1AssetDiscoveryStatus", + "GoogleCloudDataplexV1DataQualityRule": { + "description": "A rule captures data quality intent about a data source.", + "id": "GoogleCloudDataplexV1DataQualityRule", "properties": { - "lastRunDuration": { - "description": "The duration of the last discovery run.", - "format": "google-duration", + "column": { + "description": "Optional. The unnested column which this rule is evaluated against.", "type": "string" }, - "lastRunTime": { - "description": "The start time of the last discovery run.", - "format": "google-datetime", + "dimension": { + "description": "Required. The dimension a rule belongs to. Results are also aggregated at the dimension-level. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"INTEGRITY\"", "type": "string" }, - "message": { - "description": "Additional information about the current state.", + "ignoreNull": { + "description": "Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.", + "type": "boolean" + }, + "nonNullExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation", + "description": "ColumnMap rule which evaluates whether each column value is null." + }, + "rangeExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleRangeExpectation", + "description": "ColumnMap rule which evaluates whether each column value lies between a specified range." + }, + "regexExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleRegexExpectation", + "description": "ColumnMap rule which evaluates whether each column value matches a specified regex." + }, + "rowConditionExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation", + "description": "Table rule which evaluates whether each row passes the specified condition." + }, + "setExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleSetExpectation", + "description": "ColumnMap rule which evaluates whether each column value is contained by a specified set." + }, + "statisticRangeExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation", + "description": "ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range." + }, + "tableConditionExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", + "description": "Table rule which evaluates whether the provided expression is true." + }, + "threshold": { + "description": "Optional. The minimum ratio of passing_rows / total_rows required to pass this rule. Default = 1.0", + "format": "double", + "type": "number" + }, + "uniquenessExpectation": { + "$ref": "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation", + "description": "ColumnAggregate rule which evaluates whether the column has duplicates." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation": { + "description": "Evaluates whether each column value is null.", + "id": "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityRuleRangeExpectation": { + "description": "Evaluates whether each column value lies between a specified range.", + "id": "GoogleCloudDataplexV1DataQualityRuleRangeExpectation", + "properties": { + "maxValue": { + "description": "Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.", "type": "string" }, - "state": { - "description": "The current status of the discovery feature.", - "enum": [ - "STATE_UNSPECIFIED", - "SCHEDULED", - "IN_PROGRESS", - "PAUSED", - "DISABLED" - ], - "enumDescriptions": [ - "State is unspecified.", - "Discovery for the asset is scheduled.", - "Discovery for the asset is running.", - "Discovery for the asset is currently paused (e.g. due to a lack of available resources). It will be automatically resumed.", - "Discovery for the asset is disabled." - ], + "minValue": { + "description": "Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.", "type": "string" }, - "stats": { - "$ref": "GoogleCloudDataplexV1AssetDiscoveryStatusStats", - "description": "Data Stats of the asset reported by discovery." + "strictMaxEnabled": { + "description": "Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.", + "type": "boolean" }, - "updateTime": { - "description": "Last update time of the status.", - "format": "google-datetime", + "strictMinEnabled": { + "description": "Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityRuleRegexExpectation": { + "description": "Evaluates whether each column value matches a specified regex.", + "id": "GoogleCloudDataplexV1DataQualityRuleRegexExpectation", + "properties": { + "regex": { "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetDiscoveryStatusStats": { - "description": "The aggregated data statistics for the asset reported by discovery.", - "id": "GoogleCloudDataplexV1AssetDiscoveryStatusStats", + "GoogleCloudDataplexV1DataQualityRuleResult": { + "description": "DataQualityRuleResult provides a more detailed, per-rule level view of the results.", + "id": "GoogleCloudDataplexV1DataQualityRuleResult", "properties": { - "dataItems": { - "description": "The count of data items within the referenced resource.", + "evaluatedCount": { + "description": "The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules. Evaluated count can be configured to either (1) include all rows (default) - with null rows automatically failing rule evaluation OR (2) exclude null rows from the evaluated_count, by setting ignore_nulls = true", "format": "int64", "type": "string" }, - "dataSize": { - "description": "The number of stored data bytes within the referenced resource.", - "format": "int64", + "failingRowsQuery": { + "description": "The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.", "type": "string" }, - "filesets": { - "description": "The count of fileset entities within the referenced resource.", + "nullCount": { + "description": "The number of rows with null values in the specified column.", "format": "int64", "type": "string" }, - "tables": { - "description": "The count of table entities within the referenced resource.", + "passRatio": { + "description": "The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.", + "format": "double", + "type": "number" + }, + "passed": { + "description": "Whether the rule passed or failed.", + "type": "boolean" + }, + "passedCount": { + "description": "The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.", "format": "int64", "type": "string" + }, + "rule": { + "$ref": "GoogleCloudDataplexV1DataQualityRule", + "description": "The rule specified in the DataQualitySpec, as is." } }, "type": "object" }, - "GoogleCloudDataplexV1AssetResourceSpec": { - "description": "Identifies the cloud resource that is referenced by this asset.", - "id": "GoogleCloudDataplexV1AssetResourceSpec", + "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation": { + "description": "Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10", + "id": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation", "properties": { - "name": { - "description": "Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}", - "type": "string" - }, - "type": { - "description": "Required. Immutable. Type of resource.", - "enum": [ - "TYPE_UNSPECIFIED", - "STORAGE_BUCKET", - "BIGQUERY_DATASET" - ], - "enumDescriptions": [ - "Type not specified.", - "Cloud Storage bucket.", - "BigQuery dataset." - ], + "sqlExpression": { "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetResourceStatus": { - "description": "Status of the resource referenced by an asset.", - "id": "GoogleCloudDataplexV1AssetResourceStatus", + "GoogleCloudDataplexV1DataQualityRuleSetExpectation": { + "description": "Evaluates whether each column value is contained by a specified set.", + "id": "GoogleCloudDataplexV1DataQualityRuleSetExpectation", "properties": { - "message": { - "description": "Additional information about the current state.", - "type": "string" - }, - "state": { - "description": "The current state of the managed resource.", - "enum": [ - "STATE_UNSPECIFIED", - "READY", - "ERROR" - ], - "enumDescriptions": [ - "State unspecified.", - "Resource does not have any errors.", - "Resource has errors." - ], - "type": "string" - }, - "updateTime": { - "description": "Last update time of the status.", - "format": "google-datetime", - "type": "string" + "values": { + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDataplexV1AssetSecurityStatus": { - "description": "Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.", - "id": "GoogleCloudDataplexV1AssetSecurityStatus", + "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation": { + "description": "Evaluates whether the column aggregate statistic lies between a specified range.", + "id": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation", "properties": { - "message": { - "description": "Additional information about the current state.", + "maxValue": { + "description": "The maximum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.", "type": "string" }, - "state": { - "description": "The current state of the security policy applied to the attached resource.", + "minValue": { + "description": "The minimum column statistic value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.", + "type": "string" + }, + "statistic": { "enum": [ - "STATE_UNSPECIFIED", - "READY", - "APPLYING", - "ERROR" + "STATISTIC_UNDEFINED", + "MEAN", + "MIN", + "MAX" ], "enumDescriptions": [ - "State unspecified.", - "Security policy has been successfully applied to the attached resource.", - "Security policy is in the process of being applied to the attached resource.", - "Security policy could not be applied to the attached resource due to errors." + "Unspecified statistic type", + "Evaluate the column mean", + "Evaluate the column min", + "Evaluate the column max" ], - "type": "string" - }, - "updateTime": { - "description": "Last update time of the status.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDataplexV1AssetStatus": { - "description": "Aggregated status of the underlying assets of a lake or zone.", - "id": "GoogleCloudDataplexV1AssetStatus", - "properties": { - "activeAssets": { - "description": "Number of active assets.", - "format": "int32", - "type": "integer" - }, - "securityPolicyApplyingAssets": { - "description": "Number of assets that are in process of updating the security policy on attached resources.", - "format": "int32", - "type": "integer" + "type": "string" }, - "updateTime": { - "description": "Last update time of the status.", - "format": "google-datetime", + "strictMaxEnabled": { + "description": "Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a max_value has been defined. Default = false.", + "type": "boolean" + }, + "strictMinEnabled": { + "description": "Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a min_value has been defined. Default = false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation": { + "description": "Evaluates whether the provided expression is true. The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result. Example: MIN(col1) >= 0", + "id": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", + "properties": { + "sqlExpression": { "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1CancelJobRequest": { - "description": "Cancel task jobs.", - "id": "GoogleCloudDataplexV1CancelJobRequest", + "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation": { + "description": "Evaluates whether the column has duplicates.", + "id": "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation", "properties": {}, "type": "object" }, - "GoogleCloudDataplexV1Content": { - "description": "Content represents a user-visible notebook or a sql script", - "id": "GoogleCloudDataplexV1Content", + "GoogleCloudDataplexV1DataQualitySpec": { + "description": "DataQualityScan related setting.", + "id": "GoogleCloudDataplexV1DataQualitySpec", + "properties": { + "rules": { + "description": "The list of rules to evaluate against a data source. At least one rule is required.", + "items": { + "$ref": "GoogleCloudDataplexV1DataQualityRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataScan": { + "description": "Represents a user-visible job which provides the insights for the related data source. For examples: - Data Quality: generates queries based on the rules and run against the data to get data quality check results. - Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).", + "id": "GoogleCloudDataplexV1DataScan", "properties": { "createTime": { - "description": "Output only. Content creation time.", + "description": "Output only. The time when the scan was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "dataText": { - "description": "Required. Content data in string format.", - "type": "string" + "data": { + "$ref": "GoogleCloudDataplexV1DataSource", + "description": "Required. The data source for DataScan." + }, + "dataProfileResult": { + "$ref": "GoogleCloudDataplexV1DataProfileResult", + "description": "Output only. The result of the data profile scan.", + "readOnly": true + }, + "dataProfileSpec": { + "$ref": "GoogleCloudDataplexV1DataProfileSpec", + "description": "DataProfileScan related setting." + }, + "dataQualityResult": { + "$ref": "GoogleCloudDataplexV1DataQualityResult", + "description": "Output only. The result of the data quality scan.", + "readOnly": true + }, + "dataQualitySpec": { + "$ref": "GoogleCloudDataplexV1DataQualitySpec", + "description": "DataQualityScan related setting." }, "description": { - "description": "Optional. Description of the content.", + "description": "Optional. Description of the scan. * Must be between 1-1024 characters.", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly display name. * Must be between 1-256 characters.", "type": "string" }, + "executionSpec": { + "$ref": "GoogleCloudDataplexV1DataScanExecutionSpec", + "description": "Optional. DataScan execution settings. If not specified, the fields under it will use their default values." + }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. User defined labels for the content.", + "description": "Optional. User-defined labels for the scan.", "type": "object" }, "name": { - "description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", + "description": "Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.", "readOnly": true, "type": "string" }, - "notebook": { - "$ref": "GoogleCloudDataplexV1ContentNotebook", - "description": "Notebook related configurations." - }, - "path": { - "description": "Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.", + "state": { + "description": "Output only. Current state of the DataScan.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "ACTION_REQUIRED" + ], + "enumDescriptions": [ + "State is not specified.", + "Resource is active, i.e., ready to use.", + "Resource is under creation.", + "Resource is under deletion.", + "Resource is active but has unresolved actions." + ], + "readOnly": true, "type": "string" }, - "sqlScript": { - "$ref": "GoogleCloudDataplexV1ContentSqlScript", - "description": "Sql Script related configurations." + "type": { + "description": "Output only. The type of DataScan.", + "enum": [ + "DATA_SCAN_TYPE_UNSPECIFIED", + "DATA_QUALITY", + "DATA_PROFILE" + ], + "enumDescriptions": [ + "The DataScan Type is unspecified.", + "Data Quality Scan.", + "Data Profile Scan." + ], + "readOnly": true, + "type": "string" }, "uid": { - "description": "Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.", "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. The time when the content was last updated.", + "description": "Output only. The time when the scan was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3390,44 +4663,6 @@ }, "type": "object" }, - "GoogleCloudDataplexV1ContentNotebook": { - "description": "Configuration for Notebook content.", - "id": "GoogleCloudDataplexV1ContentNotebook", - "properties": { - "kernelType": { - "description": "Required. Kernel Type of the notebook.", - "enum": [ - "KERNEL_TYPE_UNSPECIFIED", - "PYTHON3" - ], - "enumDescriptions": [ - "Kernel Type unspecified.", - "Python 3 Kernel." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDataplexV1ContentSqlScript": { - "description": "Configuration for the Sql Script content.", - "id": "GoogleCloudDataplexV1ContentSqlScript", - "properties": { - "engine": { - "description": "Required. Query Engine to be used for the Sql Query.", - "enum": [ - "QUERY_ENGINE_UNSPECIFIED", - "SPARK" - ], - "enumDescriptions": [ - "Value was unspecified.", - "Spark SQL Query." - ], - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDataplexV1DataScanEvent": { "description": "These messages contain information about the execution of a datascan. The monitored resource is 'DataScan'", "id": "GoogleCloudDataplexV1DataScanEvent", @@ -3564,6 +4799,124 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataScanExecutionSpec": { + "description": "DataScan execution settings.", + "id": "GoogleCloudDataplexV1DataScanExecutionSpec", + "properties": { + "field": { + "description": "Immutable. The unnested field (Date or Timestamp) that contains values that monotonically increase over time.", + "type": "string" + }, + "trigger": { + "$ref": "GoogleCloudDataplexV1Trigger", + "description": "Optional. Spec related to how often and when a scan should be triggered. If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataScanJob": { + "description": "A DataScanJob represents an instance of a data scan.", + "id": "GoogleCloudDataplexV1DataScanJob", + "properties": { + "dataProfileResult": { + "$ref": "GoogleCloudDataplexV1DataProfileResult", + "description": "Output only. The result of the data profile scan.", + "readOnly": true + }, + "dataProfileSpec": { + "$ref": "GoogleCloudDataplexV1DataProfileSpec", + "description": "Output only. DataProfileScan related setting.", + "readOnly": true + }, + "dataQualityResult": { + "$ref": "GoogleCloudDataplexV1DataQualityResult", + "description": "Output only. The result of the data quality scan.", + "readOnly": true + }, + "dataQualitySpec": { + "$ref": "GoogleCloudDataplexV1DataQualitySpec", + "description": "Output only. DataQualityScan related setting.", + "readOnly": true + }, + "endTime": { + "description": "Output only. The time when the DataScanJob ended.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Output only. Additional information about the current state.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The time when the DataScanJob was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Execution state for the DataScanJob.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "CANCELING", + "CANCELLED", + "SUCCEEDED", + "FAILED", + "PENDING" + ], + "enumDescriptions": [ + "The DataScanJob state is unspecified.", + "The DataScanJob is running.", + "The DataScanJob is canceling.", + "The DataScanJob cancellation was successful.", + "The DataScanJob completed successfully.", + "The DataScanJob is no longer running due to an error.", + "The DataScanJob has been created but not started to run yet." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the parent DataScan.", + "enum": [ + "DATA_SCAN_TYPE_UNSPECIFIED", + "DATA_QUALITY", + "DATA_PROFILE" + ], + "enumDescriptions": [ + "The DataScan Type is unspecified.", + "Data Quality Scan.", + "Data Profile Scan." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System generated globally unique ID for the DataScanJob.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataSource": { + "description": "The data source for DataScan.", + "id": "GoogleCloudDataplexV1DataSource", + "properties": { + "entity": { + "description": "Immutable. The dataplex entity that contains the data for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DiscoveryEvent": { "description": "The payload associated with Discovery data processing.", "id": "GoogleCloudDataplexV1DiscoveryEvent", @@ -4385,6 +5738,49 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ListDataScanJobsResponse": { + "description": "List DataScanJobs response.", + "id": "GoogleCloudDataplexV1ListDataScanJobsResponse", + "properties": { + "dataScanJobs": { + "description": "DataScanJobs (metadata only) under a given dataScan.", + "items": { + "$ref": "GoogleCloudDataplexV1DataScanJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ListDataScansResponse": { + "description": "List dataScans response.", + "id": "GoogleCloudDataplexV1ListDataScansResponse", + "properties": { + "dataScans": { + "description": "DataScans (metadata only) under the given parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1DataScan" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ListEntitiesResponse": { "description": "List metadata entities response.", "id": "GoogleCloudDataplexV1ListEntitiesResponse", @@ -4614,6 +6010,53 @@ }, "type": "object" }, + "GoogleCloudDataplexV1RunDataScanRequest": { + "description": "Run DataScan Request", + "id": "GoogleCloudDataplexV1RunDataScanRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1RunDataScanResponse": { + "description": "Run DataScan Response.", + "id": "GoogleCloudDataplexV1RunDataScanResponse", + "properties": { + "job": { + "$ref": "GoogleCloudDataplexV1DataScanJob", + "description": "DataScanJob created by RunDataScan API." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ScannedData": { + "description": "The data scanned during processing (e.g. in incremental DataScan)", + "id": "GoogleCloudDataplexV1ScannedData", + "properties": { + "incrementalField": { + "$ref": "GoogleCloudDataplexV1ScannedDataIncrementalField", + "description": "The range denoted by values of an incremental field" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ScannedDataIncrementalField": { + "description": "A data range denoted by a pair of start/end values of a field.", + "id": "GoogleCloudDataplexV1ScannedDataIncrementalField", + "properties": { + "end": { + "description": "Value that marks the end of the range", + "type": "string" + }, + "field": { + "description": "The field that contains values which monotonically increases over time (e.g. timestamp).", + "type": "string" + }, + "start": { + "description": "Value that marks the start of the range", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Schema": { "description": "Schema information describing the structure and layout of the data.", "id": "GoogleCloudDataplexV1Schema", @@ -5358,6 +6801,38 @@ }, "type": "object" }, + "GoogleCloudDataplexV1Trigger": { + "description": "DataScan scheduling and trigger settings.", + "id": "GoogleCloudDataplexV1Trigger", + "properties": { + "onDemand": { + "$ref": "GoogleCloudDataplexV1TriggerOnDemand", + "description": "The scan runs one-time shortly after DataScan Creation." + }, + "schedule": { + "$ref": "GoogleCloudDataplexV1TriggerSchedule", + "description": "The scan is scheduled to run periodically." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1TriggerOnDemand": { + "description": "The scan runs one-time via RunDataScan API.", + "id": "GoogleCloudDataplexV1TriggerOnDemand", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1TriggerSchedule": { + "description": "The scan is scheduled to run periodically.", + "id": "GoogleCloudDataplexV1TriggerSchedule", + "properties": { + "cron": { + "description": "Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\". This field is required for Schedule scans.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Zone": { "description": "A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.", "id": "GoogleCloudDataplexV1Zone",