commonv1alpha1

package
v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Reason_name = map[int32]string{
		0: "REASON_UNSPECIFIED",
		1: "REASON_RESOURCE_NOT_FOUND",
		2: "REASON_INVALID_INPUT",
		3: "REASON_NO_AUTHENTICATION_TOKEN",
		4: "REASON_AUTHENTICATION_TOKEN_EXPIRED",
		5: "REASON_AUTHENTICATION_TOKEN_INVALID",
		6: "REASON_PERMISSION_DENIED",
		7: "REASON_SERVER_ERROR",
		8: "REASON_TOO_MANY_REQUESTS",
		9: "REASON_TIMEOUT",
	}
	Reason_value = map[string]int32{
		"REASON_UNSPECIFIED":                  0,
		"REASON_RESOURCE_NOT_FOUND":           1,
		"REASON_INVALID_INPUT":                2,
		"REASON_NO_AUTHENTICATION_TOKEN":      3,
		"REASON_AUTHENTICATION_TOKEN_EXPIRED": 4,
		"REASON_AUTHENTICATION_TOKEN_INVALID": 5,
		"REASON_PERMISSION_DENIED":            6,
		"REASON_SERVER_ERROR":                 7,
		"REASON_TOO_MANY_REQUESTS":            8,
		"REASON_TIMEOUT":                      9,
	}
)

Enum value maps for Reason.

View Source
var (
	Currency_name = map[int32]string{
		0: "CURRENCY_UNSPECIFIED",
		1: "CURRENCY_CURRENCY_USD_CENTS",
		2: "CURRENCY_CURRENCY_CRT",
	}
	Currency_value = map[string]int32{
		"CURRENCY_UNSPECIFIED":        0,
		"CURRENCY_CURRENCY_USD_CENTS": 1,
		"CURRENCY_CURRENCY_CRT":       2,
	}
)

Enum value maps for Currency.

View Source
var (
	// repeated string required_permission = 15350;
	E_RequiredPermission = &file_redpanda_api_common_v1alpha1_options_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var File_redpanda_api_common_v1alpha1_common_proto protoreflect.FileDescriptor
View Source
var File_redpanda_api_common_v1alpha1_money_proto protoreflect.FileDescriptor
View Source
var File_redpanda_api_common_v1alpha1_options_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Currency

type Currency int32
const (
	Currency_CURRENCY_UNSPECIFIED        Currency = 0
	Currency_CURRENCY_CURRENCY_USD_CENTS Currency = 1
	Currency_CURRENCY_CURRENCY_CRT       Currency = 2
)

func (Currency) Descriptor

func (Currency) Descriptor() protoreflect.EnumDescriptor

func (Currency) Enum

func (x Currency) Enum() *Currency

func (Currency) EnumDescriptor deprecated

func (Currency) EnumDescriptor() ([]byte, []int)

Deprecated: Use Currency.Descriptor instead.

func (Currency) Number

func (x Currency) Number() protoreflect.EnumNumber

func (Currency) String

func (x Currency) String() string

func (Currency) Type

type ErrorStatus

type ErrorStatus struct {

	// The status code, which should be an enum value of
	// [google.rpc.Code][google.rpc.Code].
	Code code.Code `protobuf:"varint,1,opt,name=code,proto3,enum=google.rpc.Code" json:"code,omitempty"`
	// A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// [google.rpc.Status.details][google.rpc.Status.details] field, or localized
	// by the client.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// A list of messages that carry the error details.  There is a common set of
	// message types for APIs to use.
	Details []*anypb.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Modified variant of google.rpc.Status, that uses enum instead of int32 for code, so it's nicer in REST. The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (*ErrorStatus) Descriptor deprecated

func (*ErrorStatus) Descriptor() ([]byte, []int)

Deprecated: Use ErrorStatus.ProtoReflect.Descriptor instead.

func (*ErrorStatus) GetCode

func (x *ErrorStatus) GetCode() code.Code

func (*ErrorStatus) GetDetails

func (x *ErrorStatus) GetDetails() []*anypb.Any

func (*ErrorStatus) GetMessage

func (x *ErrorStatus) GetMessage() string

func (*ErrorStatus) ProtoMessage

func (*ErrorStatus) ProtoMessage()

func (*ErrorStatus) ProtoReflect

func (x *ErrorStatus) ProtoReflect() protoreflect.Message

func (*ErrorStatus) Reset

func (x *ErrorStatus) Reset()

func (*ErrorStatus) String

func (x *ErrorStatus) String() string

type Money

type Money struct {

	// Amount is a decimal number.
	// Examples:
	// 10
	// 10.15
	Amount   string   `protobuf:"bytes,1,opt,name=amount,proto3" json:"amount,omitempty"`
	Currency Currency `protobuf:"varint,2,opt,name=currency,proto3,enum=redpanda.api.common.v1alpha1.Currency" json:"currency,omitempty"`
	// contains filtered or unexported fields
}

func (*Money) Descriptor deprecated

func (*Money) Descriptor() ([]byte, []int)

Deprecated: Use Money.ProtoReflect.Descriptor instead.

func (*Money) GetAmount

func (x *Money) GetAmount() string

func (*Money) GetCurrency

func (x *Money) GetCurrency() Currency

func (*Money) ProtoMessage

func (*Money) ProtoMessage()

func (*Money) ProtoReflect

func (x *Money) ProtoReflect() protoreflect.Message

func (*Money) Reset

func (x *Money) Reset()

func (*Money) String

func (x *Money) String() string

type Reason

type Reason int32
const (
	Reason_REASON_UNSPECIFIED Reason = 0
	// The specified resource could not be found.
	Reason_REASON_RESOURCE_NOT_FOUND Reason = 1
	// The input provided with the request is invalid.
	Reason_REASON_INVALID_INPUT Reason = 2
	// Authentication token is missing.
	Reason_REASON_NO_AUTHENTICATION_TOKEN Reason = 3
	// The authentication token provided has expired.
	Reason_REASON_AUTHENTICATION_TOKEN_EXPIRED Reason = 4
	// The authentication token provided is invalid.
	Reason_REASON_AUTHENTICATION_TOKEN_INVALID Reason = 5
	// The user does not have the necessary permissions.
	Reason_REASON_PERMISSION_DENIED Reason = 6
	// The request cannot be completed due to server error.
	Reason_REASON_SERVER_ERROR Reason = 7
	// The request rate is too high.
	Reason_REASON_TOO_MANY_REQUESTS Reason = 8
	// The request timed out.
	Reason_REASON_TIMEOUT Reason = 9
)

func (Reason) Descriptor

func (Reason) Descriptor() protoreflect.EnumDescriptor

func (Reason) Enum

func (x Reason) Enum() *Reason

func (Reason) EnumDescriptor deprecated

func (Reason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Reason.Descriptor instead.

func (Reason) Number

func (x Reason) Number() protoreflect.EnumNumber

func (Reason) String

func (x Reason) String() string

func (Reason) Type

func (Reason) Type() protoreflect.EnumType

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL