Class ListFileStoreDataProfilesRequest.Builder (3.53.0)

public static final class ListFileStoreDataProfilesRequest.Builder extends GeneratedMessageV3.Builder<ListFileStoreDataProfilesRequest.Builder> implements ListFileStoreDataProfilesRequestOrBuilder

Request to list the file store profiles generated for a given organization or project.

Protobuf type google.privacy.dlp.v2.ListFileStoreDataProfilesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListFileStoreDataProfilesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

build()

public ListFileStoreDataProfilesRequest build()
Returns
Type Description
ListFileStoreDataProfilesRequest

buildPartial()

public ListFileStoreDataProfilesRequest buildPartial()
Returns
Type Description
ListFileStoreDataProfilesRequest

clear()

public ListFileStoreDataProfilesRequest.Builder clear()
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListFileStoreDataProfilesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

clearFilter()

public ListFileStoreDataProfilesRequest.Builder clearFilter()

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values:
    • project_id - The Google Cloud project ID.
    • file_store_path - The path like "gs://bucket".
    • data_source_type - The profile's data source type, like "google/storage/bucket".
    • data_storage_location - The location where the file store's data is stored, like "us-central1".
    • sensitivity_level - HIGH|MODERATE|LOW
    • data_risk_level - HIGH|MODERATE|LOW
    • resource_visibility: PUBLIC|RESTRICTED
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = or !=.

    Examples:

  • project_id = 12345 AND status_code = 1

  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND resource_visibility = PUBLIC
  • file_store_path = "gs://mybucket"

    The length of this field should be no more than 500 characters.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFileStoreDataProfilesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

clearOrderBy()

public ListFileStoreDataProfilesRequest.Builder clearOrderBy()

Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.

Examples:

  • project_id asc
  • name
  • sensitivity_level desc

    Supported fields are:

  • project_id: The Google Cloud project ID.

  • sensitivity_level: How sensitive the data in a table is, at most.
  • data_risk_level: How much risk is associated with this data.
  • profile_last_generated: When the profile was last updated in epoch seconds.
  • last_modified: The last time the resource was modified.
  • resource_visibility: Visibility restriction for this resource.
  • name: The name of the profile.
  • create_time: The time the file store was first created.

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

clearPageSize()

public ListFileStoreDataProfilesRequest.Builder clearPageSize()

Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

clearPageToken()

public ListFileStoreDataProfilesRequest.Builder clearPageToken()

Optional. Page token to continue retrieval.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

clearParent()

public ListFileStoreDataProfilesRequest.Builder clearParent()

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

clone()

public ListFileStoreDataProfilesRequest.Builder clone()
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFileStoreDataProfilesRequest getDefaultInstanceForType()
Returns
Type Description
ListFileStoreDataProfilesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values:
    • project_id - The Google Cloud project ID.
    • file_store_path - The path like "gs://bucket".
    • data_source_type - The profile's data source type, like "google/storage/bucket".
    • data_storage_location - The location where the file store's data is stored, like "us-central1".
    • sensitivity_level - HIGH|MODERATE|LOW
    • data_risk_level - HIGH|MODERATE|LOW
    • resource_visibility: PUBLIC|RESTRICTED
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = or !=.

    Examples:

  • project_id = 12345 AND status_code = 1

  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND resource_visibility = PUBLIC
  • file_store_path = "gs://mybucket"

    The length of this field should be no more than 500 characters.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values:
    • project_id - The Google Cloud project ID.
    • file_store_path - The path like "gs://bucket".
    • data_source_type - The profile's data source type, like "google/storage/bucket".
    • data_storage_location - The location where the file store's data is stored, like "us-central1".
    • sensitivity_level - HIGH|MODERATE|LOW
    • data_risk_level - HIGH|MODERATE|LOW
    • resource_visibility: PUBLIC|RESTRICTED
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = or !=.

    Examples:

  • project_id = 12345 AND status_code = 1

  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND resource_visibility = PUBLIC
  • file_store_path = "gs://mybucket"

    The length of this field should be no more than 500 characters.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.

Examples:

  • project_id asc
  • name
  • sensitivity_level desc

    Supported fields are:

  • project_id: The Google Cloud project ID.

  • sensitivity_level: How sensitive the data in a table is, at most.
  • data_risk_level: How much risk is associated with this data.
  • profile_last_generated: When the profile was last updated in epoch seconds.
  • last_modified: The last time the resource was modified.
  • resource_visibility: Visibility restriction for this resource.
  • name: The name of the profile.
  • create_time: The time the file store was first created.

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.

Examples:

  • project_id asc
  • name
  • sensitivity_level desc

    Supported fields are:

  • project_id: The Google Cloud project ID.

  • sensitivity_level: How sensitive the data in a table is, at most.
  • data_risk_level: How much risk is associated with this data.
  • profile_last_generated: When the profile was last updated in epoch seconds.
  • last_modified: The last time the resource was modified.
  • resource_visibility: Visibility restriction for this resource.
  • name: The name of the profile.
  • create_time: The time the file store was first created.

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Page token to continue retrieval.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Page token to continue retrieval.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListFileStoreDataProfilesRequest other)

public ListFileStoreDataProfilesRequest.Builder mergeFrom(ListFileStoreDataProfilesRequest other)
Parameter
Name Description
other ListFileStoreDataProfilesRequest
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFileStoreDataProfilesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListFileStoreDataProfilesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFileStoreDataProfilesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListFileStoreDataProfilesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

setFilter(String value)

public ListFileStoreDataProfilesRequest.Builder setFilter(String value)

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values:
    • project_id - The Google Cloud project ID.
    • file_store_path - The path like "gs://bucket".
    • data_source_type - The profile's data source type, like "google/storage/bucket".
    • data_storage_location - The location where the file store's data is stored, like "us-central1".
    • sensitivity_level - HIGH|MODERATE|LOW
    • data_risk_level - HIGH|MODERATE|LOW
    • resource_visibility: PUBLIC|RESTRICTED
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = or !=.

    Examples:

  • project_id = 12345 AND status_code = 1

  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND resource_visibility = PUBLIC
  • file_store_path = "gs://mybucket"

    The length of this field should be no more than 500 characters.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFileStoreDataProfilesRequest.Builder setFilterBytes(ByteString value)

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values:
    • project_id - The Google Cloud project ID.
    • file_store_path - The path like "gs://bucket".
    • data_source_type - The profile's data source type, like "google/storage/bucket".
    • data_storage_location - The location where the file store's data is stored, like "us-central1".
    • sensitivity_level - HIGH|MODERATE|LOW
    • data_risk_level - HIGH|MODERATE|LOW
    • resource_visibility: PUBLIC|RESTRICTED
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = or !=.

    Examples:

  • project_id = 12345 AND status_code = 1

  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND resource_visibility = PUBLIC
  • file_store_path = "gs://mybucket"

    The length of this field should be no more than 500 characters.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListFileStoreDataProfilesRequest.Builder setOrderBy(String value)

Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.

Examples:

  • project_id asc
  • name
  • sensitivity_level desc

    Supported fields are:

  • project_id: The Google Cloud project ID.

  • sensitivity_level: How sensitive the data in a table is, at most.
  • data_risk_level: How much risk is associated with this data.
  • profile_last_generated: When the profile was last updated in epoch seconds.
  • last_modified: The last time the resource was modified.
  • resource_visibility: Visibility restriction for this resource.
  • name: The name of the profile.
  • create_time: The time the file store was first created.

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListFileStoreDataProfilesRequest.Builder setOrderByBytes(ByteString value)

Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.

Examples:

  • project_id asc
  • name
  • sensitivity_level desc

    Supported fields are:

  • project_id: The Google Cloud project ID.

  • sensitivity_level: How sensitive the data in a table is, at most.
  • data_risk_level: How much risk is associated with this data.
  • profile_last_generated: When the profile was last updated in epoch seconds.
  • last_modified: The last time the resource was modified.
  • resource_visibility: Visibility restriction for this resource.
  • name: The name of the profile.
  • create_time: The time the file store was first created.

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFileStoreDataProfilesRequest.Builder setPageSize(int value)

Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFileStoreDataProfilesRequest.Builder setPageToken(String value)

Optional. Page token to continue retrieval.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFileStoreDataProfilesRequest.Builder setPageTokenBytes(ByteString value)

Optional. Page token to continue retrieval.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setParent(String value)

public ListFileStoreDataProfilesRequest.Builder setParent(String value)

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFileStoreDataProfilesRequest.Builder setParentBytes(ByteString value)

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListFileStoreDataProfilesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListFileStoreDataProfilesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFileStoreDataProfilesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFileStoreDataProfilesRequest.Builder
Overrides