Interface ListJobTriggersRequestOrBuilder (3.39.0)

public interface ListJobTriggersRequestOrBuilder 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 triggers:
    • status - HEALTHY|PAUSED|CANCELLED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • 'last_run_time - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
    • 'error_count' - Number of errors that have occurred while running.
  • The operator must be = or !=` for status and inspected_storage.

    Examples:

  • inspected_storage = cloud_storage AND status = HEALTHY

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
  • last_run_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 5;

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 triggers:
    • status - HEALTHY|PAUSED|CANCELLED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • 'last_run_time - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
    • 'error_count' - Number of errors that have occurred while running.
  • The operator must be = or !=` for status and inspected_storage.

    Examples:

  • inspected_storage = cloud_storage AND status = HEALTHY

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
  • last_run_time > \"2017-12-12T00:00:00+00:00\"

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

string filter = 5;

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 triggeredJob 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.

Example: name asc,update_time, create_time desc

Supported fields are:

  • create_time: corresponds to the time the JobTrigger was created.
  • update_time: corresponds to the time the JobTrigger was last updated.
  • last_run_time: corresponds to the last time the JobTrigger ran.
  • name: corresponds to the JobTrigger's name.
  • display_name: corresponds to the JobTrigger's display name.
  • status: corresponds to JobTrigger's status.

string order_by = 4;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Comma separated list of triggeredJob 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.

Example: name asc,update_time, create_time desc

Supported fields are:

  • create_time: corresponds to the time the JobTrigger was created.
  • update_time: corresponds to the time the JobTrigger was last updated.
  • last_run_time: corresponds to the last time the JobTrigger ran.
  • name: corresponds to the JobTrigger's name.
  • display_name: corresponds to the JobTrigger's display name.
  • status: corresponds to JobTrigger's status.

string order_by = 4;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Size of the page. This value can be limited by a server.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Page token to continue retrieval. Comes from the previous call to ListJobTriggers. order_by field must not change for subsequent calls.

string page_token = 2;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Page token to continue retrieval. Comes from the previous call to ListJobTriggers. order_by field must not change for subsequent calls.

string page_token = 2;

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 = 1 [(.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 = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getType()

public abstract DlpJobType getType()

The type of jobs. Will use DlpJobType.INSPECT if not set.

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

Returns
TypeDescription
DlpJobType

The type.

getTypeValue()

public abstract int getTypeValue()

The type of jobs. Will use DlpJobType.INSPECT if not set.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.