Package com.google.cloud.talent.v4

Interface ListJobsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    JobView
    getJobView()
    The desired job attributes returned for jobs in the search response.
    int
    getJobViewValue()
    The desired job attributes returned for jobs in the search response.
    int
    getPageSize()
    The maximum number of jobs to be returned per page of results.
    String
    getPageToken()
    The starting point of a query result.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    The starting point of a query result.
    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 tenant under which the job is created.

 The format is "projects/{project_id}/tenants/{tenant_id}". For example,
 "projects/foo/tenants/bar".
      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 tenant under which the job is created.

 The format is "projects/{project_id}/tenants/{tenant_id}". For example,
 "projects/foo/tenants/bar".
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       Required. The filter string specifies the jobs to be enumerated.

 Supported operator: =, AND

 The fields eligible for filtering are:

 * `companyName`
 * `requisitionId`
 * `status` Available values: OPEN, EXPIRED, ALL. Defaults to
 OPEN if no value is specified.

 At least one of `companyName` and `requisitionId` must present or an
 INVALID_ARGUMENT error is thrown.

 Sample Query:

 * companyName = "projects/foo/tenants/bar/companies/baz"
 * companyName = "projects/foo/tenants/bar/companies/baz" AND
 requisitionId = "req-1"
 * companyName = "projects/foo/tenants/bar/companies/baz" AND
 status = "EXPIRED"
 * requisitionId = "req-1"
 * requisitionId = "req-1" AND status = "EXPIRED"
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Required. The filter string specifies the jobs to be enumerated.

 Supported operator: =, AND

 The fields eligible for filtering are:

 * `companyName`
 * `requisitionId`
 * `status` Available values: OPEN, EXPIRED, ALL. Defaults to
 OPEN if no value is specified.

 At least one of `companyName` and `requisitionId` must present or an
 INVALID_ARGUMENT error is thrown.

 Sample Query:

 * companyName = "projects/foo/tenants/bar/companies/baz"
 * companyName = "projects/foo/tenants/bar/companies/baz" AND
 requisitionId = "req-1"
 * companyName = "projects/foo/tenants/bar/companies/baz" AND
 status = "EXPIRED"
 * requisitionId = "req-1"
 * requisitionId = "req-1" AND status = "EXPIRED"
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for filter.

    • getPageToken

      String getPageToken()
       The starting point of a query result.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       The starting point of a query result.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getPageSize

      int getPageSize()
       The maximum number of jobs to be returned per page of results.

 If [job_view][google.cloud.talent.v4.ListJobsRequest.job_view] is set to
 [JobView.JOB_VIEW_ID_ONLY][google.cloud.talent.v4.JobView.JOB_VIEW_ID_ONLY],
 the maximum allowed page size is 1000. Otherwise, the maximum allowed page
 size is 100.

 Default is 100 if empty or a number < 1 is specified.
      int32 page_size = 4;
      Returns:
      The pageSize.

    • getJobViewValue

      int getJobViewValue()
       The desired job attributes returned for jobs in the
 search response. Defaults to
 [JobView.JOB_VIEW_FULL][google.cloud.talent.v4.JobView.JOB_VIEW_FULL] if no
 value is specified.
      .google.cloud.talent.v4.JobView job_view = 5;
      Returns:
      The enum numeric value on the wire for jobView.

    • getJobView

      JobView getJobView()
       The desired job attributes returned for jobs in the
 search response. Defaults to
 [JobView.JOB_VIEW_FULL][google.cloud.talent.v4.JobView.JOB_VIEW_FULL] if no
 value is specified.
      .google.cloud.talent.v4.JobView job_view = 5;
      Returns:
      The jobView.