2025-04-26
▼ ▲ dataplex.organizations.locations.encryptionConfigs.create
Path : v1/{+parent}/encryptionConfigs
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. The location at which the EncryptionConfig is to be created.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
encryptionConfigId
Description : Required. The ID of the EncryptionConfig to create. Currently, only a value of "default" is supported.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an EncryptionConfig.
▼ ▲ dataplex.organizations.locations.encryptionConfigs.patch
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
Pattern : ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Mask of fields to update. The service treats an omitted field mask as an implied field mask equivalent to all fields that are populated (have a non-empty value).
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an EncryptionConfig.
▼ ▲ dataplex.organizations.locations.encryptionConfigs.delete
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the EncryptionConfig to delete.
Pattern : ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. Etag of the EncryptionConfig. This is a strong etag.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an EncryptionConfig.
▼ ▲ dataplex.organizations.locations.encryptionConfigs.list
Path : v1/{+parent}/encryptionConfigs
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The location for which the EncryptionConfig is to be listed.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token received from a previous ListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided to ListEncryptionConfigs must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, create_time, update_time, encryption_state Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :), * filter=create_time>2024-05-01T00:00:00.000Z
Location : query
Type : string
orderBy
Description : Optional. Order by fields for the result.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List EncryptionConfigs.
▼ ▲ dataplex.organizations.locations.encryptionConfigs.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the EncryptionConfig to fetch.
Pattern : ^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an EncryptionConfig.