Package com.google.cloud.dataplex.v1

Interface ListDataScanJobsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListDataScanJobsRequest, ListDataScanJobsRequest.Builder
@Generated public interface ListDataScanJobsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The resource name of the parent environment:
 `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
 where `project` refers to a *project_id* or *project_number* and
 `location_id` refers to a Google Cloud region.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the parent environment:
 `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
 where `project` refers to a *project_id* or *project_number* and
 `location_id` refers to a Google Cloud region.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Optional. Maximum number of DataScanJobs to return. The service may return
 fewer than this value. If unspecified, at most 10 DataScanJobs will be
 returned. The maximum value is 1000; values above 1000 will be coerced to
 1000.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `ListDataScanJobs` call.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters provided to `ListDataScanJobs` must match the call that provided
 the page token.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `ListDataScanJobs` call.
 Provide this to retrieve the subsequent page. When paginating, all other
 parameters provided to `ListDataScanJobs` must match the call that provided
 the page token.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       Optional. An expression for filtering the results of the ListDataScanJobs
 request.

 If unspecified, all datascan jobs will be returned. Multiple filters can be
 applied (with `AND`, `OR` logical operators). Filters are case-sensitive.

 Allowed fields are:

 - `start_time`
 - `end_time`

 `start_time` and `end_time` expect RFC-3339 formatted strings (e.g.
 2018-10-08T18:30:00-07:00).

 For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time <
 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between
 specified start and end times.
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. An expression for filtering the results of the ListDataScanJobs
 request.

 If unspecified, all datascan jobs will be returned. Multiple filters can be
 applied (with `AND`, `OR` logical operators). Filters are case-sensitive.

 Allowed fields are:

 - `start_time`
 - `end_time`

 `start_time` and `end_time` expect RFC-3339 formatted strings (e.g.
 2018-10-08T18:30:00-07:00).

 For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time <
 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between
 specified start and end times.
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.