Google Cloud Dataplex V1 Client - Class ListEncryptionConfigsRequest (1.10.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEncryptionConfigsRequest.

List EncryptionConfigs Request

Generated from protobuf messagegoogle.cloud.dataplex.v1.ListEncryptionConfigsRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

Required. The location for which the EncryptionConfig is to be listed.

↳ page_sizeint

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.

↳ page_tokenstring

Optional. Page token received from a previousListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided toListEncryptionConfigs must match the call that provided the page token.

↳ filterstring

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

↳ order_bystring

Optional. Order by fields for the result.

getParent

Required. The location for which the EncryptionConfig is to be listed.

Returns
TypeDescription
string

setParent

Required. The location for which the EncryptionConfig is to be listed.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getPageSize

Optional. Maximum number of EncryptionConfigs to return. The service mayreturn fewer than this value. If unspecified, at most 10 EncryptionConfigswill be returned. The maximum value is 1000; values above 1000 will becoerced to 1000.

Returns
TypeDescription
int

setPageSize

Optional. Maximum number of EncryptionConfigs to return. The service mayreturn fewer than this value. If unspecified, at most 10 EncryptionConfigswill be returned. The maximum value is 1000; values above 1000 will becoerced to 1000.

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getPageToken

Optional. Page token received from a previousListEncryptionConfigs call.

Provide this to retrieve the subsequent page. When paginating, theparameters - filter and order_by provided toListEncryptionConfigs mustmatch the call that provided the page token.

Returns
TypeDescription
string

setPageToken

Optional. Page token received from a previousListEncryptionConfigs call.

Provide this to retrieve the subsequent page. When paginating, theparameters - filter and order_by provided toListEncryptionConfigs mustmatch the call that provided the page token.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getFilter

Optional. Filter the EncryptionConfigs to be returned.

Using bare literals: (These values will be matched anywhere it may appearin the object's field values)

  • filter=some_valueUsing fields: (These values will be matched only in the specified field)
  • filter=some_field=some_valueSupported fields:
  • name, key, create_time, update_time, encryption_stateExample:
  • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-configconjunctions: (AND, OR, NOT)
  • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-configAND mode=CMEKlogical operators: (>, <, >=, <=, !=, =, :),
  • filter=create_time>2024-05-01T00:00:00.000Z
Returns
TypeDescription
string

setFilter

Optional. Filter the EncryptionConfigs to be returned.

Using bare literals: (These values will be matched anywhere it may appearin the object's field values)

  • filter=some_valueUsing fields: (These values will be matched only in the specified field)
  • filter=some_field=some_valueSupported fields:
  • name, key, create_time, update_time, encryption_stateExample:
  • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-configconjunctions: (AND, OR, NOT)
  • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-configAND mode=CMEKlogical operators: (>, <, >=, <=, !=, =, :),
  • filter=create_time>2024-05-01T00:00:00.000Z
Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getOrderBy

Optional. Order by fields for the result.

Returns
TypeDescription
string

setOrderBy

Optional. Order by fields for the result.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parentstring

Required. The location for which the EncryptionConfig is to be listed. Please seeCmekServiceClient::organizationLocationName() for help formatting this field.

Returns
TypeDescription
ListEncryptionConfigsRequest

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-08 UTC.