123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- // Copyright 2020 Google LLC
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- syntax = "proto3";
- package google.cloud.talent.v4beta1;
- import "google/api/annotations.proto";
- import "google/api/client.proto";
- import "google/api/field_behavior.proto";
- import "google/api/resource.proto";
- import "google/cloud/talent/v4beta1/application.proto";
- import "google/cloud/talent/v4beta1/common.proto";
- import "google/protobuf/empty.proto";
- import "google/protobuf/field_mask.proto";
- option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
- option java_multiple_files = true;
- option java_outer_classname = "ApplicationServiceProto";
- option java_package = "com.google.cloud.talent.v4beta1";
- option objc_class_prefix = "CTS";
- // A service that handles application management, including CRUD and
- // enumeration.
- service ApplicationService {
- option (google.api.default_host) = "jobs.googleapis.com";
- option (google.api.oauth_scopes) =
- "https://www.googleapis.com/auth/cloud-platform,"
- "https://www.googleapis.com/auth/jobs";
- // Creates a new application entity.
- rpc CreateApplication(CreateApplicationRequest) returns (Application) {
- option (google.api.http) = {
- post: "/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications"
- body: "*"
- };
- option (google.api.method_signature) = "parent,application";
- }
- // Retrieves specified application.
- rpc GetApplication(GetApplicationRequest) returns (Application) {
- option (google.api.http) = {
- get: "/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Updates specified application.
- rpc UpdateApplication(UpdateApplicationRequest) returns (Application) {
- option (google.api.http) = {
- patch: "/v4beta1/{application.name=projects/*/tenants/*/profiles/*/applications/*}"
- body: "*"
- };
- option (google.api.method_signature) = "application";
- }
- // Deletes specified application.
- rpc DeleteApplication(DeleteApplicationRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Lists all applications associated with the profile.
- rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse) {
- option (google.api.http) = {
- get: "/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications"
- };
- option (google.api.method_signature) = "parent";
- }
- }
- // The Request of the CreateApplication method.
- message CreateApplicationRequest {
- // Required. Resource name of the profile under which the application is created.
- //
- // The format is
- // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}".
- // For example, "projects/foo/tenants/bar/profiles/baz".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "jobs.googleapis.com/Profile"
- }
- ];
- // Required. The application to be created.
- Application application = 2 [(google.api.field_behavior) = REQUIRED];
- }
- // Request for getting a application by name.
- message GetApplicationRequest {
- // Required. The resource name of the application to be retrieved.
- //
- // The format is
- // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}".
- // For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "jobs.googleapis.com/Application"
- }
- ];
- }
- // Request for updating a specified application.
- message UpdateApplicationRequest {
- // Required. The application resource to replace the current resource in the system.
- Application application = 1 [(google.api.field_behavior) = REQUIRED];
- // Strongly recommended for the best service experience.
- //
- // If [update_mask][google.cloud.talent.v4beta1.UpdateApplicationRequest.update_mask] is provided, only the specified fields in
- // [application][google.cloud.talent.v4beta1.UpdateApplicationRequest.application] are updated. Otherwise all the fields are updated.
- //
- // A field mask to specify the application fields to be updated. Only
- // top level fields of [Application][google.cloud.talent.v4beta1.Application] are supported.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request to delete a application.
- message DeleteApplicationRequest {
- // Required. The resource name of the application to be deleted.
- //
- // The format is
- // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}".
- // For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "jobs.googleapis.com/Application"
- }
- ];
- }
- // List applications for which the client has ACL visibility.
- message ListApplicationsRequest {
- // Required. Resource name of the profile under which the application is created.
- //
- // The format is
- // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for
- // example, "projects/foo/tenants/bar/profiles/baz".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "jobs.googleapis.com/Profile"
- }
- ];
- // The starting indicator from which to return results.
- string page_token = 2;
- // The maximum number of applications to be returned, at most 100.
- // Default is 100 if a non-positive number is provided.
- int32 page_size = 3;
- }
- // The List applications response object.
- message ListApplicationsResponse {
- // Applications for the current client.
- repeated Application applications = 1;
- // A token to retrieve the next page of results.
- string next_page_token = 2;
- // Additional information for the API invocation, such as the request
- // tracking id.
- ResponseMetadata metadata = 3;
- }
|