Interface ListDlpJobsRequestOrBuilder (3.32.0) 

public interface ListDlpJobsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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 abstract 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 abstract String getLocationId()

Deprecated. This field has no effect.

string location_id = 7;

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public abstract ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 7;

Returns
TypeDescription
ByteString

The bytes for locationId.

getOrderBy()

public abstract 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 abstract 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 abstract int getPageSize()

The standard list page size.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The standard list page token.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The standard list page token.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract 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 abstract 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 abstract DlpJobType getType()

The type of job. Defaults to DlpJobType.INSPECT

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

Returns
TypeDescription
DlpJobType

The type.

getTypeValue()

public abstract 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.