All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.rpc.ErrorInfoOrBuilder Maven / Gradle / Ivy

There is a newer version: 1.45.6
Show newest version
/*
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/rpc/error_details.proto

package com.google.rpc;

public interface ErrorInfoOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.rpc.ErrorInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * The reason of the error. This is a constant value that identifies the
   * proximate cause of the error. Error reasons are unique within a particular
   * domain of errors. This should be at most 63 characters and match
   * /[A-Z0-9_]+/.
   * 
* * string reason = 1; * * @return The reason. */ java.lang.String getReason(); /** * * *
   * The reason of the error. This is a constant value that identifies the
   * proximate cause of the error. Error reasons are unique within a particular
   * domain of errors. This should be at most 63 characters and match
   * /[A-Z0-9_]+/.
   * 
* * string reason = 1; * * @return The bytes for reason. */ com.google.protobuf.ByteString getReasonBytes(); /** * * *
   * The logical grouping to which the "reason" belongs. The error domain
   * is typically the registered service name of the tool or product that
   * generates the error. Example: "pubsub.googleapis.com". If the error is
   * generated by some common infrastructure, the error domain must be a
   * globally unique value that identifies the infrastructure. For Google API
   * infrastructure, the error domain is "googleapis.com".
   * 
* * string domain = 2; * * @return The domain. */ java.lang.String getDomain(); /** * * *
   * The logical grouping to which the "reason" belongs. The error domain
   * is typically the registered service name of the tool or product that
   * generates the error. Example: "pubsub.googleapis.com". If the error is
   * generated by some common infrastructure, the error domain must be a
   * globally unique value that identifies the infrastructure. For Google API
   * infrastructure, the error domain is "googleapis.com".
   * 
* * string domain = 2; * * @return The bytes for domain. */ com.google.protobuf.ByteString getDomainBytes(); /** * * *
   * Additional structured details about this error.
   * Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
   * length. When identifying the current value of an exceeded limit, the units
   * should be contained in the key, not the value.  For example, rather than
   * {"instanceLimit": "100/request"}, should be returned as,
   * {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
   * instances that can be created in a single (batch) request.
   * 
* * map<string, string> metadata = 3; */ int getMetadataCount(); /** * * *
   * Additional structured details about this error.
   * Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
   * length. When identifying the current value of an exceeded limit, the units
   * should be contained in the key, not the value.  For example, rather than
   * {"instanceLimit": "100/request"}, should be returned as,
   * {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
   * instances that can be created in a single (batch) request.
   * 
* * map<string, string> metadata = 3; */ boolean containsMetadata(java.lang.String key); /** Use {@link #getMetadataMap()} instead. */ @java.lang.Deprecated java.util.Map getMetadata(); /** * * *
   * Additional structured details about this error.
   * Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
   * length. When identifying the current value of an exceeded limit, the units
   * should be contained in the key, not the value.  For example, rather than
   * {"instanceLimit": "100/request"}, should be returned as,
   * {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
   * instances that can be created in a single (batch) request.
   * 
* * map<string, string> metadata = 3; */ java.util.Map getMetadataMap(); /** * * *
   * Additional structured details about this error.
   * Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
   * length. When identifying the current value of an exceeded limit, the units
   * should be contained in the key, not the value.  For example, rather than
   * {"instanceLimit": "100/request"}, should be returned as,
   * {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
   * instances that can be created in a single (batch) request.
   * 
* * map<string, string> metadata = 3; */ java.lang.String getMetadataOrDefault(java.lang.String key, java.lang.String defaultValue); /** * * *
   * Additional structured details about this error.
   * Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
   * length. When identifying the current value of an exceeded limit, the units
   * should be contained in the key, not the value.  For example, rather than
   * {"instanceLimit": "100/request"}, should be returned as,
   * {"instanceLimitPerRequest": "100"}, if the client exceeds the number of
   * instances that can be created in a single (batch) request.
   * 
* * map<string, string> metadata = 3; */ java.lang.String getMetadataOrThrow(java.lang.String key); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy