apiv1

package
v0.0.0-...-3e9429a Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: Apache-2.0 Imports: 18 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Use a random high number that won't conflict with annotations from other
	// libraries.
	//
	// optional admiral.api.v1.Reference reference = 58901;
	E_Reference = &file_api_v1_annotations_proto_extTypes[0]
	// optional admiral.api.v1.Identifier id = 58902;
	E_Id = &file_api_v1_annotations_proto_extTypes[1]
	// optional bool redacted = 58903;
	E_Redacted = &file_api_v1_annotations_proto_extTypes[2]
)

Extension fields to descriptorpb.MessageOptions.

View Source 
var (
	// Use a random high number that won't conflict with annotations from other
	// libraries.
	//
	// optional admiral.api.v1.Action action = 58901;
	E_Action = &file_api_v1_annotations_proto_extTypes[4]
	// optional bool disable_audit = 58902;
	E_DisableAudit = &file_api_v1_annotations_proto_extTypes[5]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var (
	ActionType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "CREATE",
		2: "READ",
		3: "UPDATE",
		4: "DELETE",
	}
	ActionType_value = map[string]int32{
		"UNSPECIFIED": 0,
		"CREATE":      1,
		"READ":        2,
		"UPDATE":      3,
		"DELETE":      4,
	}
)

Enum value maps for ActionType.

View Source 
var (
	// Fields with the log option set to false will be cleared during auditing.
	// Defaults to true.
	//
	// optional bool log = 58901;
	E_Log = &file_api_v1_annotations_proto_extTypes[3]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var File_api_v1_annotations_proto protoreflect.FileDescriptor
View Source 
var File_api_v1_error_proto protoreflect.FileDescriptor
View Source 
var File_api_v1_schema_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Action 

type Action struct {

	// The type of action being performed.
	Type ActionType `protobuf:"varint,1,opt,name=type,proto3,enum=admiral.api.v1.ActionType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*Action) Descriptor deprecated 

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

Deprecated: Use Action.ProtoReflect.Descriptor instead.

func (*Action) GetType 

func (x *Action) GetType() ActionType

func (*Action) ProtoMessage 

func (*Action) ProtoMessage()

func (*Action) ProtoReflect 

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

func (*Action) Reset 

func (x *Action) Reset()

func (*Action) String 

func (x *Action) String() string

func (*Action) Validate 

func (m *Action) Validate() error

Validate checks the field values on Action with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Action) ValidateAll 

func (m *Action) ValidateAll() error

ValidateAll checks the field values on Action with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ActionMultiError, or nil if none found.

type ActionMultiError 

type ActionMultiError []error

ActionMultiError is an error wrapping multiple validation errors returned by Action.ValidateAll() if the designated constraints aren't met.

func (ActionMultiError) AllErrors 

func (m ActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ActionMultiError) Error 

func (m ActionMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ActionType 

type ActionType int32
const (
	ActionType_UNSPECIFIED ActionType = 0
	ActionType_CREATE      ActionType = 1
	ActionType_READ        ActionType = 2
	ActionType_UPDATE      ActionType = 3
	ActionType_DELETE      ActionType = 4
)

func (ActionType) Descriptor 

func (ActionType) Descriptor() protoreflect.EnumDescriptor

func (ActionType) Enum 

func (x ActionType) Enum() *ActionType

func (ActionType) EnumDescriptor deprecated 

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

Deprecated: Use ActionType.Descriptor instead.

func (ActionType) Number 

func (x ActionType) Number() protoreflect.EnumNumber

func (ActionType) String 

func (x ActionType) String() string

func (ActionType) Type 

func (ActionType) Type() protoreflect.EnumType

type ActionValidationError 

type ActionValidationError struct {
	// contains filtered or unexported fields
}

ActionValidationError is the validation error returned by Action.Validate if the designated constraints aren't met.

func (ActionValidationError) Cause 

func (e ActionValidationError) Cause() error

Cause function returns cause value.

func (ActionValidationError) Error 

func (e ActionValidationError) Error() string

Error satisfies the builtin error interface

func (ActionValidationError) ErrorName 

func (e ActionValidationError) ErrorName() string

ErrorName returns error name.

func (ActionValidationError) Field 

func (e ActionValidationError) Field() string

Field function returns field value.

func (ActionValidationError) Key 

func (e ActionValidationError) Key() bool

Key function returns key value.

func (ActionValidationError) Reason 

func (e ActionValidationError) Reason() string

Reason function returns reason value.

type ErrorDetails 

type ErrorDetails struct {

	// If there are any underlying errors that were being wrapped, they are
	// presented here.
	Wrapped []*status.Status `protobuf:"bytes,1,rep,name=wrapped,proto3" json:"wrapped,omitempty"`
	// contains filtered or unexported fields
}

Any error information beyond code and status should be included here and added to the error in the status details field. The frontend knows how to render all of the fields in a user-friendly way. If there is extremely verbose error information, consider adding it using a different type, e.g. from the errdetails package. Any details not using this type will still be accessible to the user in a raw format.

func (*ErrorDetails) Descriptor deprecated 

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

Deprecated: Use ErrorDetails.ProtoReflect.Descriptor instead.

func (*ErrorDetails) GetWrapped 

func (x *ErrorDetails) GetWrapped() []*status.Status

func (*ErrorDetails) ProtoMessage 

func (*ErrorDetails) ProtoMessage()

func (*ErrorDetails) ProtoReflect 

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

func (*ErrorDetails) Reset 

func (x *ErrorDetails) Reset()

func (*ErrorDetails) String 

func (x *ErrorDetails) String() string

func (*ErrorDetails) Validate 

func (m *ErrorDetails) Validate() error

Validate checks the field values on ErrorDetails with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ErrorDetails) ValidateAll 

func (m *ErrorDetails) ValidateAll() error

ValidateAll checks the field values on ErrorDetails with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ErrorDetailsMultiError, or nil if none found.

type ErrorDetailsMultiError 

type ErrorDetailsMultiError []error

ErrorDetailsMultiError is an error wrapping multiple validation errors returned by ErrorDetails.ValidateAll() if the designated constraints aren't met.

func (ErrorDetailsMultiError) AllErrors 

func (m ErrorDetailsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ErrorDetailsMultiError) Error 

func (m ErrorDetailsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ErrorDetailsValidationError 

type ErrorDetailsValidationError struct {
	// contains filtered or unexported fields
}

ErrorDetailsValidationError is the validation error returned by ErrorDetails.Validate if the designated constraints aren't met.

func (ErrorDetailsValidationError) Cause 

func (e ErrorDetailsValidationError) Cause() error

Cause function returns cause value.

func (ErrorDetailsValidationError) Error 

func (e ErrorDetailsValidationError) Error() string

Error satisfies the builtin error interface

func (ErrorDetailsValidationError) ErrorName 

func (e ErrorDetailsValidationError) ErrorName() string

ErrorName returns error name.

func (ErrorDetailsValidationError) Field 

func (e ErrorDetailsValidationError) Field() string

Field function returns field value.

func (ErrorDetailsValidationError) Key 

func (e ErrorDetailsValidationError) Key() bool

Key function returns key value.

func (ErrorDetailsValidationError) Reason 

func (e ErrorDetailsValidationError) Reason() string

Reason function returns reason value.

type Identifier 

type Identifier struct {
	Patterns []*Pattern `protobuf:"bytes,1,rep,name=patterns,proto3" json:"patterns,omitempty"`
	// contains filtered or unexported fields
}

func (*Identifier) Descriptor deprecated 

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

Deprecated: Use Identifier.ProtoReflect.Descriptor instead.

func (*Identifier) GetPatterns 

func (x *Identifier) GetPatterns() []*Pattern

func (*Identifier) ProtoMessage 

func (*Identifier) ProtoMessage()

func (*Identifier) ProtoReflect 

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

func (*Identifier) Reset 

func (x *Identifier) Reset()

func (*Identifier) String 

func (x *Identifier) String() string

func (*Identifier) Validate 

func (m *Identifier) Validate() error

Validate checks the field values on Identifier with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Identifier) ValidateAll 

func (m *Identifier) ValidateAll() error

ValidateAll checks the field values on Identifier with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in IdentifierMultiError, or nil if none found.

type IdentifierMultiError 

type IdentifierMultiError []error

IdentifierMultiError is an error wrapping multiple validation errors returned by Identifier.ValidateAll() if the designated constraints aren't met.

func (IdentifierMultiError) AllErrors 

func (m IdentifierMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (IdentifierMultiError) Error 

func (m IdentifierMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type IdentifierValidationError 

type IdentifierValidationError struct {
	// contains filtered or unexported fields
}

IdentifierValidationError is the validation error returned by Identifier.Validate if the designated constraints aren't met.

func (IdentifierValidationError) Cause 

func (e IdentifierValidationError) Cause() error

Cause function returns cause value.

func (IdentifierValidationError) Error 

func (e IdentifierValidationError) Error() string

Error satisfies the builtin error interface

func (IdentifierValidationError) ErrorName 

func (e IdentifierValidationError) ErrorName() string

ErrorName returns error name.

func (IdentifierValidationError) Field 

func (e IdentifierValidationError) Field() string

Field function returns field value.

func (IdentifierValidationError) Key 

func (e IdentifierValidationError) Key() bool

Key function returns key value.

func (IdentifierValidationError) Reason 

func (e IdentifierValidationError) Reason() string

Reason function returns reason value.

type Pattern 

type Pattern struct {

	// The type URL for the resource.
	TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// A string describing the resource name in terms
	// of message members.
	Pattern string `protobuf:"bytes,2,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// contains filtered or unexported fields
}

func (*Pattern) Descriptor deprecated 

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

Deprecated: Use Pattern.ProtoReflect.Descriptor instead.

func (*Pattern) GetPattern 

func (x *Pattern) GetPattern() string

func (*Pattern) GetTypeUrl 

func (x *Pattern) GetTypeUrl() string

func (*Pattern) ProtoMessage 

func (*Pattern) ProtoMessage()

func (*Pattern) ProtoReflect 

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

func (*Pattern) Reset 

func (x *Pattern) Reset()

func (*Pattern) String 

func (x *Pattern) String() string

func (*Pattern) Validate 

func (m *Pattern) Validate() error

Validate checks the field values on Pattern with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Pattern) ValidateAll 

func (m *Pattern) ValidateAll() error

ValidateAll checks the field values on Pattern with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PatternMultiError, or nil if none found.

type PatternMultiError 

type PatternMultiError []error

PatternMultiError is an error wrapping multiple validation errors returned by Pattern.ValidateAll() if the designated constraints aren't met.

func (PatternMultiError) AllErrors 

func (m PatternMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PatternMultiError) Error 

func (m PatternMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PatternValidationError 

type PatternValidationError struct {
	// contains filtered or unexported fields
}

PatternValidationError is the validation error returned by Pattern.Validate if the designated constraints aren't met.

func (PatternValidationError) Cause 

func (e PatternValidationError) Cause() error

Cause function returns cause value.

func (PatternValidationError) Error 

func (e PatternValidationError) Error() string

Error satisfies the builtin error interface

func (PatternValidationError) ErrorName 

func (e PatternValidationError) ErrorName() string

ErrorName returns error name.

func (PatternValidationError) Field 

func (e PatternValidationError) Field() string

Field function returns field value.

func (PatternValidationError) Key 

func (e PatternValidationError) Key() bool

Key function returns key value.

func (PatternValidationError) Reason 

func (e PatternValidationError) Reason() string

Reason function returns reason value.

type Redacted 

type Redacted struct {
	RedactedTypeUrl string `protobuf:"bytes,1,opt,name=redacted_type_url,json=redactedTypeUrl,proto3" json:"redacted_type_url,omitempty"`
	// contains filtered or unexported fields
}

Message used to represent redacted messages.

func (*Redacted) Descriptor deprecated 

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

Deprecated: Use Redacted.ProtoReflect.Descriptor instead.

func (*Redacted) GetRedactedTypeUrl 

func (x *Redacted) GetRedactedTypeUrl() string

func (*Redacted) ProtoMessage 

func (*Redacted) ProtoMessage()

func (*Redacted) ProtoReflect 

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

func (*Redacted) Reset 

func (x *Redacted) Reset()

func (*Redacted) String 

func (x *Redacted) String() string

func (*Redacted) Validate 

func (m *Redacted) Validate() error

Validate checks the field values on Redacted with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Redacted) ValidateAll 

func (m *Redacted) ValidateAll() error

ValidateAll checks the field values on Redacted with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RedactedMultiError, or nil if none found.

type RedactedMultiError 

type RedactedMultiError []error

RedactedMultiError is an error wrapping multiple validation errors returned by Redacted.ValidateAll() if the designated constraints aren't met.

func (RedactedMultiError) AllErrors 

func (m RedactedMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RedactedMultiError) Error 

func (m RedactedMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RedactedValidationError 

type RedactedValidationError struct {
	// contains filtered or unexported fields
}

RedactedValidationError is the validation error returned by Redacted.Validate if the designated constraints aren't met.

func (RedactedValidationError) Cause 

func (e RedactedValidationError) Cause() error

Cause function returns cause value.

func (RedactedValidationError) Error 

func (e RedactedValidationError) Error() string

Error satisfies the builtin error interface

func (RedactedValidationError) ErrorName 

func (e RedactedValidationError) ErrorName() string

ErrorName returns error name.

func (RedactedValidationError) Field 

func (e RedactedValidationError) Field() string

Field function returns field value.

func (RedactedValidationError) Key 

func (e RedactedValidationError) Key() bool

Key function returns key value.

func (RedactedValidationError) Reason 

func (e RedactedValidationError) Reason() string

Reason function returns reason value.

type Reference 

type Reference struct {

	// The field(s) which contain nested ResourceIdentifiers to
	// identify resources contained in the message.
	Fields []string `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*Reference) Descriptor deprecated 

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

Deprecated: Use Reference.ProtoReflect.Descriptor instead.

func (*Reference) GetFields 

func (x *Reference) GetFields() []string

func (*Reference) ProtoMessage 

func (*Reference) ProtoMessage()

func (*Reference) ProtoReflect 

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

func (*Reference) Reset 

func (x *Reference) Reset()

func (*Reference) String 

func (x *Reference) String() string

func (*Reference) Validate 

func (m *Reference) Validate() error

Validate checks the field values on Reference with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Reference) ValidateAll 

func (m *Reference) ValidateAll() error

ValidateAll checks the field values on Reference with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ReferenceMultiError, or nil if none found.

type ReferenceMultiError 

type ReferenceMultiError []error

ReferenceMultiError is an error wrapping multiple validation errors returned by Reference.ValidateAll() if the designated constraints aren't met.

func (ReferenceMultiError) AllErrors 

func (m ReferenceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ReferenceMultiError) Error 

func (m ReferenceMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ReferenceValidationError 

type ReferenceValidationError struct {
	// contains filtered or unexported fields
}

ReferenceValidationError is the validation error returned by Reference.Validate if the designated constraints aren't met.

func (ReferenceValidationError) Cause 

func (e ReferenceValidationError) Cause() error

Cause function returns cause value.

func (ReferenceValidationError) Error 

func (e ReferenceValidationError) Error() string

Error satisfies the builtin error interface

func (ReferenceValidationError) ErrorName 

func (e ReferenceValidationError) ErrorName() string

ErrorName returns error name.

func (ReferenceValidationError) Field 

func (e ReferenceValidationError) Field() string

Field function returns field value.

func (ReferenceValidationError) Key 

func (e ReferenceValidationError) Key() bool

Key function returns key value.

func (ReferenceValidationError) Reason 

func (e ReferenceValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.