Class ListDlpJobsRequest.Builder (3.24.0) 

public static final class ListDlpJobsRequest.Builder extends GeneratedMessageV3.Builder<ListDlpJobsRequest.Builder> implements ListDlpJobsRequestOrBuilder

The request message for listing DLP jobs.

Protobuf type google.privacy.dlp.v2.ListDlpJobsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListDlpJobsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDlpJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

build()

public ListDlpJobsRequest build()
Returns
TypeDescription
ListDlpJobsRequest

buildPartial()

public ListDlpJobsRequest buildPartial()
Returns
TypeDescription
ListDlpJobsRequest

clear()

public ListDlpJobsRequest.Builder clear()
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListDlpJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

clearFilter()

public ListDlpJobsRequest.Builder clearFilter()

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 for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The name of the trigger that created the job.
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.

  • The operator must be = or !=.

    Examples:

  • inspected_storage = cloud_storage AND state = done

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

  • end_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 1;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearLocationId()

public ListDlpJobsRequest.Builder clearLocationId()

Deprecated. This field has no effect.

string location_id = 7;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDlpJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

clearOrderBy()

public ListDlpJobsRequest.Builder clearOrderBy()

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, end_time asc, create_time desc

Supported fields are:

  • create_time: corresponds to the time the job was created.
  • end_time: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state

string order_by = 6;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearPageSize()

public ListDlpJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 2;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListDlpJobsRequest.Builder clearPageToken()

The standard list page token.

string page_token = 3;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearParent()

public ListDlpJobsRequest.Builder clearParent()

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

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

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clearType()

public ListDlpJobsRequest.Builder clearType()

The type of job. Defaults to DlpJobType.INSPECT

.google.privacy.dlp.v2.DlpJobType type = 5;

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

clone()

public ListDlpJobsRequest.Builder clone()
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListDlpJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListDlpJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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 for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The name of the trigger that created the job.
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.

  • The operator must be = or !=.

    Examples:

  • inspected_storage = cloud_storage AND state = done

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

  • end_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 1;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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 for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The name of the trigger that created the job.
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.

  • The operator must be = or !=.

    Examples:

  • inspected_storage = cloud_storage AND state = done

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

  • end_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 1;

Returns
TypeDescription
ByteString

The bytes for filter.

getLocationId()

public String getLocationId()

Deprecated. This field has no effect.

string location_id = 7;

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 7;

Returns
TypeDescription
ByteString

The bytes for locationId.

getOrderBy()

public String getOrderBy()

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, end_time asc, create_time desc

Supported fields are:

  • create_time: corresponds to the time the job was created.
  • end_time: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state

string order_by = 6;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, end_time asc, create_time desc

Supported fields are:

  • create_time: corresponds to the time the job was created.
  • end_time: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state

string order_by = 6;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The standard list page token.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

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

Returns
TypeDescription
ByteString

The bytes for parent.

getType()

public DlpJobType getType()

The type of job. Defaults to DlpJobType.INSPECT

.google.privacy.dlp.v2.DlpJobType type = 5;

Returns
TypeDescription
DlpJobType

The type.

getTypeValue()

public int getTypeValue()

The type of job. Defaults to DlpJobType.INSPECT

.google.privacy.dlp.v2.DlpJobType type = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListDlpJobsRequest other)

public ListDlpJobsRequest.Builder mergeFrom(ListDlpJobsRequest other)
Parameter
NameDescription
otherListDlpJobsRequest
Returns
TypeDescription
ListDlpJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDlpJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListDlpJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDlpJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListDlpJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

setFilter(String value)

public ListDlpJobsRequest.Builder setFilter(String value)

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 for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The name of the trigger that created the job.
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.

  • The operator must be = or !=.

    Examples:

  • inspected_storage = cloud_storage AND state = done

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

  • end_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 1;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDlpJobsRequest.Builder setFilterBytes(ByteString value)

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 for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The name of the trigger that created the job.
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'end_time - Corresponds to the time the job finished.
    • 'start_time - Corresponds to the time the job finished.

  • The operator must be = or !=.

    Examples:

  • inspected_storage = cloud_storage AND state = done

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

  • end_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 1;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setLocationId(String value)

public ListDlpJobsRequest.Builder setLocationId(String value)

Deprecated. This field has no effect.

string location_id = 7;

Parameter
NameDescription
valueString

The locationId to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setLocationIdBytes(ByteString value)

public ListDlpJobsRequest.Builder setLocationIdBytes(ByteString value)

Deprecated. This field has no effect.

string location_id = 7;

Parameter
NameDescription
valueByteString

The bytes for locationId to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListDlpJobsRequest.Builder setOrderBy(String value)

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, end_time asc, create_time desc

Supported fields are:

  • create_time: corresponds to the time the job was created.
  • end_time: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state

string order_by = 6;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListDlpJobsRequest.Builder setOrderByBytes(ByteString value)

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, end_time asc, create_time desc

Supported fields are:

  • create_time: corresponds to the time the job was created.
  • end_time: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state

string order_by = 6;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListDlpJobsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDlpJobsRequest.Builder setPageToken(String value)

The standard list page token.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDlpJobsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListDlpJobsRequest.Builder setParent(String value)

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDlpJobsRequest.Builder setParentBytes(ByteString value)

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>

  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

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

public ListDlpJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides

setType(DlpJobType value)

public ListDlpJobsRequest.Builder setType(DlpJobType value)

The type of job. Defaults to DlpJobType.INSPECT

.google.privacy.dlp.v2.DlpJobType type = 5;

Parameter
NameDescription
valueDlpJobType

The type to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setTypeValue(int value)

public ListDlpJobsRequest.Builder setTypeValue(int value)

The type of job. Defaults to DlpJobType.INSPECT

.google.privacy.dlp.v2.DlpJobType type = 5;

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
ListDlpJobsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDlpJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDlpJobsRequest.Builder
Overrides