// Copyright 2017 Google Inc. // // 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. // @generated by protoc-gen-es v1.10.0 with parameter "target=ts" // @generated from file google/rpc/error_details.proto (package google.rpc, syntax proto3) /* eslint-disable */ // @ts-nocheck import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf"; import { Message, proto3 } from "@bufbuild/protobuf"; import { Duration } from "../protobuf/duration_pb.js"; /** * Describes when the clients can retry a failed request. Clients could ignore * the recommendation here or retry when this information is missing from error * responses. * * It's always recommended that clients should use exponential backoff when * retrying. * * Clients should wait until `retry_delay` amount of time has passed since * receiving the error response before retrying. If retrying requests also * fail, clients should use an exponential backoff scheme to gradually increase * the delay between retries based on `retry_delay`, until either a maximum * number of retires have been reached or a maximum retry delay cap has been * reached. * * @generated from message google.rpc.RetryInfo */ export class RetryInfo extends Message { /** * Clients should wait at least this long between retrying the same request. * * @generated from field: google.protobuf.Duration retry_delay = 1; */ retryDelay?: Duration; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.RetryInfo"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "retry_delay", kind: "message", T: Duration }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): RetryInfo { return new RetryInfo().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): RetryInfo { return new RetryInfo().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): RetryInfo { return new RetryInfo().fromJsonString(jsonString, options); } static equals(a: RetryInfo | PlainMessage | undefined, b: RetryInfo | PlainMessage | undefined): boolean { return proto3.util.equals(RetryInfo, a, b); } } /** * Describes additional debugging info. * * @generated from message google.rpc.DebugInfo */ export class DebugInfo extends Message { /** * The stack trace entries indicating where the error occurred. * * @generated from field: repeated string stack_entries = 1; */ stackEntries: string[] = []; /** * Additional debugging information provided by the server. * * @generated from field: string detail = 2; */ detail = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.DebugInfo"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "stack_entries", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 2, name: "detail", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): DebugInfo { return new DebugInfo().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): DebugInfo { return new DebugInfo().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): DebugInfo { return new DebugInfo().fromJsonString(jsonString, options); } static equals(a: DebugInfo | PlainMessage | undefined, b: DebugInfo | PlainMessage | undefined): boolean { return proto3.util.equals(DebugInfo, a, b); } } /** * Describes how a quota check failed. * * For example if a daily limit was exceeded for the calling project, * a service could respond with a QuotaFailure detail containing the project * id and the description of the quota limit that was exceeded. If the * calling project hasn't enabled the service in the developer console, then * a service could respond with the project id and set `service_disabled` * to true. * * Also see RetryDetail and Help types for other details about handling a * quota failure. * * @generated from message google.rpc.QuotaFailure */ export class QuotaFailure extends Message { /** * Describes all quota violations. * * @generated from field: repeated google.rpc.QuotaFailure.Violation violations = 1; */ violations: QuotaFailure_Violation[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.QuotaFailure"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "violations", kind: "message", T: QuotaFailure_Violation, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): QuotaFailure { return new QuotaFailure().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): QuotaFailure { return new QuotaFailure().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): QuotaFailure { return new QuotaFailure().fromJsonString(jsonString, options); } static equals(a: QuotaFailure | PlainMessage | undefined, b: QuotaFailure | PlainMessage | undefined): boolean { return proto3.util.equals(QuotaFailure, a, b); } } /** * A message type used to describe a single quota violation. For example, a * daily quota or a custom quota that was exceeded. * * @generated from message google.rpc.QuotaFailure.Violation */ export class QuotaFailure_Violation extends Message { /** * The subject on which the quota check failed. * For example, "clientip:" or "project:". * * @generated from field: string subject = 1; */ subject = ""; /** * A description of how the quota check failed. Clients can use this * description to find more about the quota configuration in the service's * public documentation, or find the relevant quota limit to adjust through * developer console. * * For example: "Service disabled" or "Daily Limit for read operations * exceeded". * * @generated from field: string description = 2; */ description = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.QuotaFailure.Violation"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "subject", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): QuotaFailure_Violation { return new QuotaFailure_Violation().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): QuotaFailure_Violation { return new QuotaFailure_Violation().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): QuotaFailure_Violation { return new QuotaFailure_Violation().fromJsonString(jsonString, options); } static equals(a: QuotaFailure_Violation | PlainMessage | undefined, b: QuotaFailure_Violation | PlainMessage | undefined): boolean { return proto3.util.equals(QuotaFailure_Violation, a, b); } } /** * Describes what preconditions have failed. * * For example, if an RPC failed because it required the Terms of Service to be * acknowledged, it could list the terms of service violation in the * PreconditionFailure message. * * @generated from message google.rpc.PreconditionFailure */ export class PreconditionFailure extends Message { /** * Describes all precondition violations. * * @generated from field: repeated google.rpc.PreconditionFailure.Violation violations = 1; */ violations: PreconditionFailure_Violation[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.PreconditionFailure"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "violations", kind: "message", T: PreconditionFailure_Violation, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): PreconditionFailure { return new PreconditionFailure().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): PreconditionFailure { return new PreconditionFailure().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): PreconditionFailure { return new PreconditionFailure().fromJsonString(jsonString, options); } static equals(a: PreconditionFailure | PlainMessage | undefined, b: PreconditionFailure | PlainMessage | undefined): boolean { return proto3.util.equals(PreconditionFailure, a, b); } } /** * A message type used to describe a single precondition failure. * * @generated from message google.rpc.PreconditionFailure.Violation */ export class PreconditionFailure_Violation extends Message { /** * The type of PreconditionFailure. We recommend using a service-specific * enum type to define the supported precondition violation types. For * example, "TOS" for "Terms of Service violation". * * @generated from field: string type = 1; */ type = ""; /** * The subject, relative to the type, that failed. * For example, "google.com/cloud" relative to the "TOS" type would * indicate which terms of service is being referenced. * * @generated from field: string subject = 2; */ subject = ""; /** * A description of how the precondition failed. Developers can use this * description to understand how to fix the failure. * * For example: "Terms of service not accepted". * * @generated from field: string description = 3; */ description = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.PreconditionFailure.Violation"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "type", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "subject", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): PreconditionFailure_Violation { return new PreconditionFailure_Violation().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): PreconditionFailure_Violation { return new PreconditionFailure_Violation().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): PreconditionFailure_Violation { return new PreconditionFailure_Violation().fromJsonString(jsonString, options); } static equals(a: PreconditionFailure_Violation | PlainMessage | undefined, b: PreconditionFailure_Violation | PlainMessage | undefined): boolean { return proto3.util.equals(PreconditionFailure_Violation, a, b); } } /** * Describes violations in a client request. This error type focuses on the * syntactic aspects of the request. * * @generated from message google.rpc.BadRequest */ export class BadRequest extends Message { /** * Describes all violations in a client request. * * @generated from field: repeated google.rpc.BadRequest.FieldViolation field_violations = 1; */ fieldViolations: BadRequest_FieldViolation[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.BadRequest"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "field_violations", kind: "message", T: BadRequest_FieldViolation, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): BadRequest { return new BadRequest().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): BadRequest { return new BadRequest().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): BadRequest { return new BadRequest().fromJsonString(jsonString, options); } static equals(a: BadRequest | PlainMessage | undefined, b: BadRequest | PlainMessage | undefined): boolean { return proto3.util.equals(BadRequest, a, b); } } /** * A message type used to describe a single bad request field. * * @generated from message google.rpc.BadRequest.FieldViolation */ export class BadRequest_FieldViolation extends Message { /** * A path leading to a field in the request body. The value will be a * sequence of dot-separated identifiers that identify a protocol buffer * field. E.g., "field_violations.field" would identify this field. * * @generated from field: string field = 1; */ field = ""; /** * A description of why the request element is bad. * * @generated from field: string description = 2; */ description = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.BadRequest.FieldViolation"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "field", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): BadRequest_FieldViolation { return new BadRequest_FieldViolation().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): BadRequest_FieldViolation { return new BadRequest_FieldViolation().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): BadRequest_FieldViolation { return new BadRequest_FieldViolation().fromJsonString(jsonString, options); } static equals(a: BadRequest_FieldViolation | PlainMessage | undefined, b: BadRequest_FieldViolation | PlainMessage | undefined): boolean { return proto3.util.equals(BadRequest_FieldViolation, a, b); } } /** * Contains metadata about the request that clients can attach when filing a bug * or providing other forms of feedback. * * @generated from message google.rpc.RequestInfo */ export class RequestInfo extends Message { /** * An opaque string that should only be interpreted by the service generating * it. For example, it can be used to identify requests in the service's logs. * * @generated from field: string request_id = 1; */ requestId = ""; /** * Any data that was used to serve this request. For example, an encrypted * stack trace that can be sent back to the service provider for debugging. * * @generated from field: string serving_data = 2; */ servingData = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.RequestInfo"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "request_id", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "serving_data", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): RequestInfo { return new RequestInfo().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): RequestInfo { return new RequestInfo().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): RequestInfo { return new RequestInfo().fromJsonString(jsonString, options); } static equals(a: RequestInfo | PlainMessage | undefined, b: RequestInfo | PlainMessage | undefined): boolean { return proto3.util.equals(RequestInfo, a, b); } } /** * Describes the resource that is being accessed. * * @generated from message google.rpc.ResourceInfo */ export class ResourceInfo extends Message { /** * A name for the type of resource being accessed, e.g. "sql table", * "cloud storage bucket", "file", "Google calendar"; or the type URL * of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic". * * @generated from field: string resource_type = 1; */ resourceType = ""; /** * The name of the resource being accessed. For example, a shared calendar * name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current * error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED]. * * @generated from field: string resource_name = 2; */ resourceName = ""; /** * The owner of the resource (optional). * For example, "user:" or "project:". * * @generated from field: string owner = 3; */ owner = ""; /** * Describes what error is encountered when accessing this resource. * For example, updating a cloud project may require the `writer` permission * on the developer console project. * * @generated from field: string description = 4; */ description = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.ResourceInfo"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "resource_type", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "resource_name", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 4, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): ResourceInfo { return new ResourceInfo().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): ResourceInfo { return new ResourceInfo().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): ResourceInfo { return new ResourceInfo().fromJsonString(jsonString, options); } static equals(a: ResourceInfo | PlainMessage | undefined, b: ResourceInfo | PlainMessage | undefined): boolean { return proto3.util.equals(ResourceInfo, a, b); } } /** * Provides links to documentation or for performing an out of band action. * * For example, if a quota check failed with an error indicating the calling * project hasn't enabled the accessed service, this can contain a URL pointing * directly to the right place in the developer console to flip the bit. * * @generated from message google.rpc.Help */ export class Help extends Message { /** * URL(s) pointing to additional information on handling the current error. * * @generated from field: repeated google.rpc.Help.Link links = 1; */ links: Help_Link[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.Help"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "links", kind: "message", T: Help_Link, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Help { return new Help().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Help { return new Help().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Help { return new Help().fromJsonString(jsonString, options); } static equals(a: Help | PlainMessage | undefined, b: Help | PlainMessage | undefined): boolean { return proto3.util.equals(Help, a, b); } } /** * Describes a URL link. * * @generated from message google.rpc.Help.Link */ export class Help_Link extends Message { /** * Describes what the link offers. * * @generated from field: string description = 1; */ description = ""; /** * The URL of the link. * * @generated from field: string url = 2; */ url = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.Help.Link"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Help_Link { return new Help_Link().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Help_Link { return new Help_Link().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Help_Link { return new Help_Link().fromJsonString(jsonString, options); } static equals(a: Help_Link | PlainMessage | undefined, b: Help_Link | PlainMessage | undefined): boolean { return proto3.util.equals(Help_Link, a, b); } } /** * Provides a localized error message that is safe to return to the user * which can be attached to an RPC error. * * @generated from message google.rpc.LocalizedMessage */ export class LocalizedMessage extends Message { /** * The locale used following the specification defined at * http://www.rfc-editor.org/rfc/bcp/bcp47.txt. * Examples are: "en-US", "fr-CH", "es-MX" * * @generated from field: string locale = 1; */ locale = ""; /** * The localized error message in the above locale. * * @generated from field: string message = 2; */ message = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "google.rpc.LocalizedMessage"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "locale", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): LocalizedMessage { return new LocalizedMessage().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): LocalizedMessage { return new LocalizedMessage().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): LocalizedMessage { return new LocalizedMessage().fromJsonString(jsonString, options); } static equals(a: LocalizedMessage | PlainMessage | undefined, b: LocalizedMessage | PlainMessage | undefined): boolean { return proto3.util.equals(LocalizedMessage, a, b); } }