xref: /aosp_15_r20/external/googleapis/google/cloud/datapipelines/logging/v1/logging.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1// Copyright 2022 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.datapipelines.logging.v1;
18
19import "google/rpc/status.proto";
20
21option go_package = "cloud.google.com/go/datapipelines/logging/apiv1/loggingpb;loggingpb";
22option java_multiple_files = true;
23option java_outer_classname = "LoggingProto";
24option java_package = "com.google.cloud.datapipelines.logging.v1";
25
26// Cloud Logging structured payload for events generated from Data Pipelines API
27// requests.
28message RequestLogEntry {
29  // Type of a Data Pipelines API request.
30  enum RequestType {
31    // Default value. This value is not used.
32    REQUEST_TYPE_UNSPECIFIED = 0;
33
34    // A Data Pipelines Create Pipeline request.
35    CREATE_PIPELINE = 1;
36
37    // A Data Pipelines Update Pipeline request.
38    UPDATE_PIPELINE = 2;
39
40    // A Data Pipelines Delete Pipeline request.
41    DELETE_PIPELINE = 3;
42
43    // A Data Pipelines List Pipelines request.
44    LIST_PIPELINES = 4;
45
46    // A Data Pipelines Get Pipeline request.
47    GET_PIPELINE = 5;
48
49    // A Data Pipelines Stop Pipeline request.
50    STOP_PIPELINE = 6;
51
52    // A Data Pipelines Run Pipeline request.
53    RUN_PIPELINE = 7;
54
55    // A Data Pipelines List Jobs request.
56    LIST_JOBS = 8;
57  }
58
59  // Cause code for a Data Pipelines API request error.
60  enum ErrorCause {
61    // Default value. This value is not used.
62    ERROR_CAUSE_UNSPECIFIED = 0;
63
64    // The request is invalid.
65    INVALID_REQUEST = 1;
66
67    // Failed to fetch project number for the provided project id.
68    PROJECT_NUMBER_NOT_FOUND = 2;
69
70    // The given pipeline already exists.
71    PIPELINE_ID_ALREADY_EXISTS = 3;
72
73    // Failed to allocate a token for the per project pipeline count quota.
74    PIPELINE_QUOTA_ALLOCATION_FAILED = 4;
75
76    // The given pipeline is not found.
77    PIPELINE_NOT_FOUND = 5;
78
79    // The pipeline's workload is invalid.
80    INVALID_PIPELINE_WORKLOAD = 6;
81
82    // The user cannot act as the Dataflow worker service account.
83    DATAFLOW_WORKER_SERVICE_ACCOUNT_PERMISSION_DENIED = 7;
84
85    // The user cannot act as the Cloud Scheduler service account.
86    CLOUD_SCHEDULER_SERVICE_ACCOUNT_PERMISSION_DENIED = 8;
87
88    // Issues related to the per service per project service account.
89    INTERNAL_DATA_PIPELINES_SERVICE_ACCOUNT_ISSUE = 9;
90
91    // Invalid argument in Cloud Scheduler service call.
92    CLOUD_SCHEDULER_INVALID_ARGUMENT = 10;
93
94    // Exceeds Cloud Scheduler service quota limit.
95    CLOUD_SCHEDULER_RESOURCE_EXHAUSTED = 11;
96
97    // Cloud Scheduler job not found.
98    CLOUD_SCHEDULER_JOB_NOT_FOUND = 12;
99
100    // Other Cloud Scheduler related issues.
101    OTHER_CLOUD_SCHEDULER_ISSUE = 13;
102
103    // Dataflow job with the same name already exists.
104    DATAFLOW_JOB_ALREADY_EXISTS = 14;
105
106    // Invalid argument in Dataflow service call.
107    DATAFLOW_INVALID_ARGUMENT = 15;
108
109    // Exceeds Dataflow service quota limit.
110    DATAFLOW_RESOURCE_EXHAUSTED = 16;
111
112    // Dataflow job not found.
113    DATAFLOW_JOB_NOT_FOUND = 17;
114
115    // Other Dataflow related issues.
116    OTHER_DATAFLOW_ISSUE = 18;
117
118    // Database related issues.
119    DATABASE_ERROR = 19;
120
121    // Request with the wrong pipeline type. For example, RunPipeline cannot be
122    // used with a streaming pipeline.
123    WRONG_PIPELINE_TYPE = 20;
124
125    // Issues related to other Google internal services/systems.
126    INTERNAL_ERROR = 21;
127
128    // Cannot find the given pipeline or project.
129    PIPELINE_OR_PROJECT_NOT_FOUND = 22;
130  }
131
132  // Type of the Data Pipelines API request.
133  RequestType request_type = 1;
134
135  // The resulting status of the Data Pipelines API request.
136  google.rpc.Status status = 2;
137
138  // Cause of the error status.
139  ErrorCause error_cause = 3;
140}
141