Google Cloud Dataplex V1 Client - Class ListEncryptionConfigsRequest (1.7.1)

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

List EncryptionConfigs Request

Generated from protobuf message google.cloud.dataplex.v1.ListEncryptionConfigsRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

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

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_token string

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.
↳ filter string

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_by string

Optional. Order by fields for the result.

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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
Returns
Type Description
string

setFilter

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
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Order by fields for the result.

Returns
Type Description
string

setOrderBy

Optional. Order by fields for the result.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The location for which the EncryptionConfig is to be listed. Please see CmekServiceClient::organizationLocationName() for help formatting this field.
Returns
Type Description
ListEncryptionConfigsRequest