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/rpc/status.proto 18 19 package com.google.rpc; 20 21 public interface StatusOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.rpc.Status) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The status code, which should be an enum value of 31 * [google.rpc.Code][google.rpc.Code]. 32 * </pre> 33 * 34 * <code>int32 code = 1;</code> 35 * 36 * @return The code. 37 */ getCode()38 int getCode(); 39 40 /** 41 * 42 * 43 * <pre> 44 * A developer-facing error message, which should be in English. Any 45 * user-facing error message should be localized and sent in the 46 * [google.rpc.Status.details][google.rpc.Status.details] field, or localized 47 * by the client. 48 * </pre> 49 * 50 * <code>string message = 2;</code> 51 * 52 * @return The message. 53 */ getMessage()54 java.lang.String getMessage(); 55 /** 56 * 57 * 58 * <pre> 59 * A developer-facing error message, which should be in English. Any 60 * user-facing error message should be localized and sent in the 61 * [google.rpc.Status.details][google.rpc.Status.details] field, or localized 62 * by the client. 63 * </pre> 64 * 65 * <code>string message = 2;</code> 66 * 67 * @return The bytes for message. 68 */ getMessageBytes()69 com.google.protobuf.ByteString getMessageBytes(); 70 71 /** 72 * 73 * 74 * <pre> 75 * A list of messages that carry the error details. There is a common set of 76 * message types for APIs to use. 77 * </pre> 78 * 79 * <code>repeated .google.protobuf.Any details = 3;</code> 80 */ getDetailsList()81 java.util.List<com.google.protobuf.Any> getDetailsList(); 82 /** 83 * 84 * 85 * <pre> 86 * A list of messages that carry the error details. There is a common set of 87 * message types for APIs to use. 88 * </pre> 89 * 90 * <code>repeated .google.protobuf.Any details = 3;</code> 91 */ getDetails(int index)92 com.google.protobuf.Any getDetails(int index); 93 /** 94 * 95 * 96 * <pre> 97 * A list of messages that carry the error details. There is a common set of 98 * message types for APIs to use. 99 * </pre> 100 * 101 * <code>repeated .google.protobuf.Any details = 3;</code> 102 */ getDetailsCount()103 int getDetailsCount(); 104 /** 105 * 106 * 107 * <pre> 108 * A list of messages that carry the error details. There is a common set of 109 * message types for APIs to use. 110 * </pre> 111 * 112 * <code>repeated .google.protobuf.Any details = 3;</code> 113 */ getDetailsOrBuilderList()114 java.util.List<? extends com.google.protobuf.AnyOrBuilder> getDetailsOrBuilderList(); 115 /** 116 * 117 * 118 * <pre> 119 * A list of messages that carry the error details. There is a common set of 120 * message types for APIs to use. 121 * </pre> 122 * 123 * <code>repeated .google.protobuf.Any details = 3;</code> 124 */ getDetailsOrBuilder(int index)125 com.google.protobuf.AnyOrBuilder getDetailsOrBuilder(int index); 126 } 127