1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/talent/v4/job_service.proto 18 19 package com.google.cloud.talent.v4; 20 21 public interface ListJobsRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.talent.v4.ListJobsRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The resource name of the tenant under which the job is created. 31 * The format is "projects/{project_id}/tenants/{tenant_id}". For example, 32 * "projects/foo/tenants/bar". 33 * </pre> 34 * 35 * <code> 36 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 37 * </code> 38 * 39 * @return The parent. 40 */ getParent()41 java.lang.String getParent(); 42 /** 43 * 44 * 45 * <pre> 46 * Required. The resource name of the tenant under which the job is created. 47 * The format is "projects/{project_id}/tenants/{tenant_id}". For example, 48 * "projects/foo/tenants/bar". 49 * </pre> 50 * 51 * <code> 52 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 53 * </code> 54 * 55 * @return The bytes for parent. 56 */ getParentBytes()57 com.google.protobuf.ByteString getParentBytes(); 58 59 /** 60 * 61 * 62 * <pre> 63 * Required. The filter string specifies the jobs to be enumerated. 64 * Supported operator: =, AND 65 * The fields eligible for filtering are: 66 * * `companyName` 67 * * `requisitionId` 68 * * `status` Available values: OPEN, EXPIRED, ALL. Defaults to 69 * OPEN if no value is specified. 70 * At least one of `companyName` and `requisitionId` must present or an 71 * INVALID_ARGUMENT error is thrown. 72 * Sample Query: 73 * * companyName = "projects/foo/tenants/bar/companies/baz" 74 * * companyName = "projects/foo/tenants/bar/companies/baz" AND 75 * requisitionId = "req-1" 76 * * companyName = "projects/foo/tenants/bar/companies/baz" AND 77 * status = "EXPIRED" 78 * * requisitionId = "req-1" 79 * * requisitionId = "req-1" AND status = "EXPIRED" 80 * </pre> 81 * 82 * <code>string filter = 2 [(.google.api.field_behavior) = REQUIRED];</code> 83 * 84 * @return The filter. 85 */ getFilter()86 java.lang.String getFilter(); 87 /** 88 * 89 * 90 * <pre> 91 * Required. The filter string specifies the jobs to be enumerated. 92 * Supported operator: =, AND 93 * The fields eligible for filtering are: 94 * * `companyName` 95 * * `requisitionId` 96 * * `status` Available values: OPEN, EXPIRED, ALL. Defaults to 97 * OPEN if no value is specified. 98 * At least one of `companyName` and `requisitionId` must present or an 99 * INVALID_ARGUMENT error is thrown. 100 * Sample Query: 101 * * companyName = "projects/foo/tenants/bar/companies/baz" 102 * * companyName = "projects/foo/tenants/bar/companies/baz" AND 103 * requisitionId = "req-1" 104 * * companyName = "projects/foo/tenants/bar/companies/baz" AND 105 * status = "EXPIRED" 106 * * requisitionId = "req-1" 107 * * requisitionId = "req-1" AND status = "EXPIRED" 108 * </pre> 109 * 110 * <code>string filter = 2 [(.google.api.field_behavior) = REQUIRED];</code> 111 * 112 * @return The bytes for filter. 113 */ getFilterBytes()114 com.google.protobuf.ByteString getFilterBytes(); 115 116 /** 117 * 118 * 119 * <pre> 120 * The starting point of a query result. 121 * </pre> 122 * 123 * <code>string page_token = 3;</code> 124 * 125 * @return The pageToken. 126 */ getPageToken()127 java.lang.String getPageToken(); 128 /** 129 * 130 * 131 * <pre> 132 * The starting point of a query result. 133 * </pre> 134 * 135 * <code>string page_token = 3;</code> 136 * 137 * @return The bytes for pageToken. 138 */ getPageTokenBytes()139 com.google.protobuf.ByteString getPageTokenBytes(); 140 141 /** 142 * 143 * 144 * <pre> 145 * The maximum number of jobs to be returned per page of results. 146 * If [job_view][google.cloud.talent.v4.ListJobsRequest.job_view] is set to 147 * [JobView.JOB_VIEW_ID_ONLY][google.cloud.talent.v4.JobView.JOB_VIEW_ID_ONLY], 148 * the maximum allowed page size is 1000. Otherwise, the maximum allowed page 149 * size is 100. 150 * Default is 100 if empty or a number < 1 is specified. 151 * </pre> 152 * 153 * <code>int32 page_size = 4;</code> 154 * 155 * @return The pageSize. 156 */ getPageSize()157 int getPageSize(); 158 159 /** 160 * 161 * 162 * <pre> 163 * The desired job attributes returned for jobs in the 164 * search response. Defaults to 165 * [JobView.JOB_VIEW_FULL][google.cloud.talent.v4.JobView.JOB_VIEW_FULL] if no 166 * value is specified. 167 * </pre> 168 * 169 * <code>.google.cloud.talent.v4.JobView job_view = 5;</code> 170 * 171 * @return The enum numeric value on the wire for jobView. 172 */ getJobViewValue()173 int getJobViewValue(); 174 /** 175 * 176 * 177 * <pre> 178 * The desired job attributes returned for jobs in the 179 * search response. Defaults to 180 * [JobView.JOB_VIEW_FULL][google.cloud.talent.v4.JobView.JOB_VIEW_FULL] if no 181 * value is specified. 182 * </pre> 183 * 184 * <code>.google.cloud.talent.v4.JobView job_view = 5;</code> 185 * 186 * @return The jobView. 187 */ getJobView()188 com.google.cloud.talent.v4.JobView getJobView(); 189 } 190