1type: google.api.Service 2config_version: 3 3name: dataplex.googleapis.com 4title: Cloud Dataplex API 5 6apis: 7- name: google.cloud.dataplex.v1.CatalogService 8- name: google.cloud.dataplex.v1.ContentService 9- name: google.cloud.dataplex.v1.DataScanService 10- name: google.cloud.dataplex.v1.DataTaxonomyService 11- name: google.cloud.dataplex.v1.DataplexService 12- name: google.cloud.dataplex.v1.MetadataService 13- name: google.cloud.location.Locations 14- name: google.iam.v1.IAMPolicy 15- name: google.longrunning.Operations 16 17types: 18- name: google.cloud.dataplex.v1.DataQualityScanRuleResult 19- name: google.cloud.dataplex.v1.DataScanEvent 20- name: google.cloud.dataplex.v1.DiscoveryEvent 21- name: google.cloud.dataplex.v1.GovernanceEvent 22- name: google.cloud.dataplex.v1.JobEvent 23- name: google.cloud.dataplex.v1.OperationMetadata 24- name: google.cloud.dataplex.v1.SessionEvent 25 26documentation: 27 summary: Dataplex API is used to manage the lifecycle of data lakes. 28 rules: 29 - selector: google.cloud.location.Locations.GetLocation 30 description: Gets information about a location. 31 32 - selector: google.cloud.location.Locations.ListLocations 33 description: Lists information about the supported locations for this service. 34 35 - selector: google.iam.v1.IAMPolicy.GetIamPolicy 36 description: |- 37 Gets the access control policy for a resource. Returns an empty policy 38 if the resource exists and does not have a policy set. 39 40 - selector: google.iam.v1.IAMPolicy.SetIamPolicy 41 description: |- 42 Sets the access control policy on the specified resource. Replaces 43 any existing policy. 44 45 Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` 46 errors. 47 48 - selector: google.iam.v1.IAMPolicy.TestIamPermissions 49 description: |- 50 Returns permissions that a caller has on the specified resource. If the 51 resource does not exist, this will return an empty set of 52 permissions, not a `NOT_FOUND` error. 53 54 Note: This operation is designed to be used for building 55 permission-aware UIs and command-line tools, not for authorization 56 checking. This operation may "fail open" without warning. 57 58http: 59 rules: 60 - selector: google.cloud.location.Locations.GetLocation 61 get: '/v1/{name=projects/*/locations/*}' 62 - selector: google.cloud.location.Locations.ListLocations 63 get: '/v1/{name=projects/*}/locations' 64 - selector: google.iam.v1.IAMPolicy.GetIamPolicy 65 get: '/v1/{resource=projects/*/locations/*/lakes/*}:getIamPolicy' 66 additional_bindings: 67 - get: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*}:getIamPolicy' 68 - get: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:getIamPolicy' 69 - get: '/v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:getIamPolicy' 70 - get: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:getIamPolicy' 71 - get: '/v1/{resource=projects/*/locations/*/dataScans/*}:getIamPolicy' 72 - get: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:getIamPolicy' 73 - get: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:getIamPolicy' 74 - get: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:getIamPolicy' 75 - get: '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy' 76 - get: '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy' 77 - get: '/v1/{resource=projects/*/locations/*/entryGroups/*}:getIamPolicy' 78 - get: '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy' 79 - selector: google.iam.v1.IAMPolicy.SetIamPolicy 80 post: '/v1/{resource=projects/*/locations/*/lakes/*}:setIamPolicy' 81 body: '*' 82 additional_bindings: 83 - post: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*}:setIamPolicy' 84 body: '*' 85 - post: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:setIamPolicy' 86 body: '*' 87 - post: '/v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:setIamPolicy' 88 body: '*' 89 - post: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:setIamPolicy' 90 body: '*' 91 - post: '/v1/{resource=projects/*/locations/*/dataScans/*}:setIamPolicy' 92 body: '*' 93 - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:setIamPolicy' 94 body: '*' 95 - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:setIamPolicy' 96 body: '*' 97 - post: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:setIamPolicy' 98 body: '*' 99 - post: '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy' 100 body: '*' 101 - post: '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy' 102 body: '*' 103 - post: '/v1/{resource=projects/*/locations/*/entryGroups/*}:setIamPolicy' 104 body: '*' 105 - post: '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy' 106 body: '*' 107 - selector: google.iam.v1.IAMPolicy.TestIamPermissions 108 post: '/v1/{resource=projects/*/locations/*/lakes/*}:testIamPermissions' 109 body: '*' 110 additional_bindings: 111 - post: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*}:testIamPermissions' 112 body: '*' 113 - post: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:testIamPermissions' 114 body: '*' 115 - post: '/v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:testIamPermissions' 116 body: '*' 117 - post: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:testIamPermissions' 118 body: '*' 119 - post: '/v1/{resource=projects/*/locations/*/dataScans/*}:testIamPermissions' 120 body: '*' 121 - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:testIamPermissions' 122 body: '*' 123 - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:testIamPermissions' 124 body: '*' 125 - post: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:testIamPermissions' 126 body: '*' 127 - post: '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions' 128 body: '*' 129 - post: '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions' 130 body: '*' 131 - post: '/v1/{resource=projects/*/locations/*/entryGroups/*}:testIamPermissions' 132 body: '*' 133 - post: '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions' 134 body: '*' 135 - selector: google.longrunning.Operations.CancelOperation 136 post: '/v1/{name=projects/*/locations/*/operations/*}:cancel' 137 body: '*' 138 - selector: google.longrunning.Operations.DeleteOperation 139 delete: '/v1/{name=projects/*/locations/*/operations/*}' 140 - selector: google.longrunning.Operations.GetOperation 141 get: '/v1/{name=projects/*/locations/*/operations/*}' 142 - selector: google.longrunning.Operations.ListOperations 143 get: '/v1/{name=projects/*/locations/*}/operations' 144 145authentication: 146 rules: 147 - selector: 'google.cloud.dataplex.v1.CatalogService.*' 148 oauth: 149 canonical_scopes: |- 150 https://www.googleapis.com/auth/cloud-platform 151 - selector: 'google.cloud.dataplex.v1.ContentService.*' 152 oauth: 153 canonical_scopes: |- 154 https://www.googleapis.com/auth/cloud-platform 155 - selector: 'google.cloud.dataplex.v1.DataScanService.*' 156 oauth: 157 canonical_scopes: |- 158 https://www.googleapis.com/auth/cloud-platform 159 - selector: 'google.cloud.dataplex.v1.DataTaxonomyService.*' 160 oauth: 161 canonical_scopes: |- 162 https://www.googleapis.com/auth/cloud-platform 163 - selector: 'google.cloud.dataplex.v1.DataplexService.*' 164 oauth: 165 canonical_scopes: |- 166 https://www.googleapis.com/auth/cloud-platform 167 - selector: 'google.cloud.dataplex.v1.MetadataService.*' 168 oauth: 169 canonical_scopes: |- 170 https://www.googleapis.com/auth/cloud-platform 171 - selector: google.cloud.location.Locations.GetLocation 172 oauth: 173 canonical_scopes: |- 174 https://www.googleapis.com/auth/cloud-platform 175 - selector: google.cloud.location.Locations.ListLocations 176 oauth: 177 canonical_scopes: |- 178 https://www.googleapis.com/auth/cloud-platform 179 - selector: 'google.iam.v1.IAMPolicy.*' 180 oauth: 181 canonical_scopes: |- 182 https://www.googleapis.com/auth/cloud-platform 183 - selector: 'google.longrunning.Operations.*' 184 oauth: 185 canonical_scopes: |- 186 https://www.googleapis.com/auth/cloud-platform 187 188publishing: 189 new_issue_uri: https://issuetracker.google.com/issues/new?component=1155079&template=1656695 190 documentation_uri: https://cloud.google.com/dataplex/docs/overview 191 api_short_name: dataplex 192 github_label: 'api: dataplex' 193 doc_tag_prefix: dataplex 194 organization: CLOUD 195 library_settings: 196 - version: google.cloud.dataplex.v1 197 launch_stage: ALPHA 198 java_settings: 199 common: 200 destinations: 201 - PACKAGE_MANAGER 202 cpp_settings: 203 common: 204 destinations: 205 - PACKAGE_MANAGER 206 php_settings: 207 common: 208 destinations: 209 - PACKAGE_MANAGER 210 python_settings: 211 common: 212 destinations: 213 - PACKAGE_MANAGER 214 node_settings: 215 common: 216 destinations: 217 - PACKAGE_MANAGER 218 dotnet_settings: 219 common: 220 destinations: 221 - PACKAGE_MANAGER 222 ruby_settings: 223 common: 224 destinations: 225 - PACKAGE_MANAGER 226 go_settings: 227 common: 228 destinations: 229 - PACKAGE_MANAGER 230 proto_reference_documentation_uri: https://cloud.google.com/dataplex/docs/reference/rpc 231