grpc_playground_common_go

package module
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2022 License: Apache-2.0 Imports: 16 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	OpStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "SUCCESS",
	}
	OpStatus_value = map[string]int32{
		"UNKNOWN": 0,
		"SUCCESS": 1,
	}
)

Enum value maps for OpStatus.

View Source
var File_playground_common_entities_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type EmptyRequest

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

Empty message as required by gRPC for services not requiring any parameters.

func (*EmptyRequest) Descriptor deprecated

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

Deprecated: Use EmptyRequest.ProtoReflect.Descriptor instead.

func (*EmptyRequest) ProtoMessage

func (*EmptyRequest) ProtoMessage()

func (*EmptyRequest) ProtoReflect

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

func (*EmptyRequest) Reset

func (x *EmptyRequest) Reset()

func (*EmptyRequest) String

func (x *EmptyRequest) String() string

func (*EmptyRequest) Validate

func (m *EmptyRequest) Validate() error

Validate checks the field values on EmptyRequest 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 (*EmptyRequest) ValidateAll added in v0.4.0

func (m *EmptyRequest) ValidateAll() error

ValidateAll checks the field values on EmptyRequest 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 EmptyRequestMultiError, or nil if none found.

type EmptyRequestMultiError added in v0.4.0

type EmptyRequestMultiError []error

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

func (EmptyRequestMultiError) AllErrors added in v0.4.0

func (m EmptyRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EmptyRequestMultiError) Error added in v0.4.0

func (m EmptyRequestMultiError) Error() string

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

type EmptyRequestValidationError

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

EmptyRequestValidationError is the validation error returned by EmptyRequest.Validate if the designated constraints aren't met.

func (EmptyRequestValidationError) Cause

Cause function returns cause value.

func (EmptyRequestValidationError) Error

Error satisfies the builtin error interface

func (EmptyRequestValidationError) ErrorName

func (e EmptyRequestValidationError) ErrorName() string

ErrorName returns error name.

func (EmptyRequestValidationError) Field

Field function returns field value.

func (EmptyRequestValidationError) Key

Key function returns key value.

func (EmptyRequestValidationError) Reason

Reason function returns reason value.

type GenericGetRequest added in v0.5.0

type GenericGetRequest struct {

	// EnvironmentQualifiedName (EnvQN) contains both the account name and the environment name as
	// <account_name>/<env_name>.
	EnvironmentQualifiedName string `` /* 135-byte string literal not displayed */
	// AccountId with the account identifier.
	AccountId string `protobuf:"bytes,2,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// EnvironmentId with the environment identifier
	EnvironmentId string `protobuf:"bytes,3,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// Name with the name of the entity
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// IncludeYAMLConversion determines if the raw YAML representation is also included.
	IncludeYamlConversion bool `` /* 127-byte string literal not displayed */
	// IncludeJSONConversion determines if the raw JSON representation is also included.
	IncludeJsonConversion bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

GenericGetRequest with the information required to get an entity

func (*GenericGetRequest) Descriptor deprecated added in v0.5.0

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

Deprecated: Use GenericGetRequest.ProtoReflect.Descriptor instead.

func (*GenericGetRequest) GetAccountId added in v0.5.0

func (x *GenericGetRequest) GetAccountId() string

func (*GenericGetRequest) GetEnvironmentId added in v0.5.0

func (x *GenericGetRequest) GetEnvironmentId() string

func (*GenericGetRequest) GetEnvironmentQualifiedName added in v0.5.0

func (x *GenericGetRequest) GetEnvironmentQualifiedName() string

func (*GenericGetRequest) GetIncludeJsonConversion added in v0.5.0

func (x *GenericGetRequest) GetIncludeJsonConversion() bool

func (*GenericGetRequest) GetIncludeYamlConversion added in v0.5.0

func (x *GenericGetRequest) GetIncludeYamlConversion() bool

func (*GenericGetRequest) GetName added in v0.5.0

func (x *GenericGetRequest) GetName() string

func (*GenericGetRequest) ProtoMessage added in v0.5.0

func (*GenericGetRequest) ProtoMessage()

func (*GenericGetRequest) ProtoReflect added in v0.5.0

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

func (*GenericGetRequest) Reset added in v0.5.0

func (x *GenericGetRequest) Reset()

func (*GenericGetRequest) String added in v0.5.0

func (x *GenericGetRequest) String() string

func (*GenericGetRequest) Validate added in v0.5.0

func (m *GenericGetRequest) Validate() error

Validate checks the field values on GenericGetRequest 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 (*GenericGetRequest) ValidateAll added in v0.5.0

func (m *GenericGetRequest) ValidateAll() error

ValidateAll checks the field values on GenericGetRequest 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 GenericGetRequestMultiError, or nil if none found.

type GenericGetRequestMultiError added in v0.5.0

type GenericGetRequestMultiError []error

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

func (GenericGetRequestMultiError) AllErrors added in v0.5.0

func (m GenericGetRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GenericGetRequestMultiError) Error added in v0.5.0

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

type GenericGetRequestValidationError added in v0.5.0

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

GenericGetRequestValidationError is the validation error returned by GenericGetRequest.Validate if the designated constraints aren't met.

func (GenericGetRequestValidationError) Cause added in v0.5.0

Cause function returns cause value.

func (GenericGetRequestValidationError) Error added in v0.5.0

Error satisfies the builtin error interface

func (GenericGetRequestValidationError) ErrorName added in v0.5.0

ErrorName returns error name.

func (GenericGetRequestValidationError) Field added in v0.5.0

Field function returns field value.

func (GenericGetRequestValidationError) Key added in v0.5.0

Key function returns key value.

func (GenericGetRequestValidationError) Reason added in v0.5.0

Reason function returns reason value.

type GenericListRequest added in v0.4.0

type GenericListRequest struct {

	// IncludeYAMLConversion determines if the raw YAML representation is also included.
	IncludeYamlConversion bool `` /* 127-byte string literal not displayed */
	// IncludeJSONConversion determines if the raw JSON representation is also included.
	IncludeJsonConversion bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

GenericListRequest with the information required to List entities

func (*GenericListRequest) Descriptor deprecated added in v0.4.0

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

Deprecated: Use GenericListRequest.ProtoReflect.Descriptor instead.

func (*GenericListRequest) GetIncludeJsonConversion added in v0.4.0

func (x *GenericListRequest) GetIncludeJsonConversion() bool

func (*GenericListRequest) GetIncludeYamlConversion added in v0.4.0

func (x *GenericListRequest) GetIncludeYamlConversion() bool

func (*GenericListRequest) ProtoMessage added in v0.4.0

func (*GenericListRequest) ProtoMessage()

func (*GenericListRequest) ProtoReflect added in v0.4.0

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

func (*GenericListRequest) Reset added in v0.4.0

func (x *GenericListRequest) Reset()

func (*GenericListRequest) String added in v0.4.0

func (x *GenericListRequest) String() string

func (*GenericListRequest) Validate added in v0.4.0

func (m *GenericListRequest) Validate() error

Validate checks the field values on GenericListRequest 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 (*GenericListRequest) ValidateAll added in v0.4.0

func (m *GenericListRequest) ValidateAll() error

ValidateAll checks the field values on GenericListRequest 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 GenericListRequestMultiError, or nil if none found.

type GenericListRequestMultiError added in v0.4.0

type GenericListRequestMultiError []error

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

func (GenericListRequestMultiError) AllErrors added in v0.4.0

func (m GenericListRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GenericListRequestMultiError) Error added in v0.4.0

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

type GenericListRequestValidationError added in v0.4.0

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

GenericListRequestValidationError is the validation error returned by GenericListRequest.Validate if the designated constraints aren't met.

func (GenericListRequestValidationError) Cause added in v0.4.0

Cause function returns cause value.

func (GenericListRequestValidationError) Error added in v0.4.0

Error satisfies the builtin error interface

func (GenericListRequestValidationError) ErrorName added in v0.4.0

ErrorName returns error name.

func (GenericListRequestValidationError) Field added in v0.4.0

Field function returns field value.

func (GenericListRequestValidationError) Key added in v0.4.0

Key function returns key value.

func (GenericListRequestValidationError) Reason added in v0.4.0

Reason function returns reason value.

type OpResponse

type OpResponse struct {

	// Status of the operation.
	Status OpStatus `protobuf:"varint,1,opt,name=status,proto3,enum=playground_common.OpStatus" json:"status,omitempty"`
	// StatusName with the string representation of the status.
	StatusName string `protobuf:"bytes,2,opt,name=status_name,json=statusName,proto3" json:"status_name,omitempty"`
	// UserInfo with additional information to show to the user.
	UserInfo string `protobuf:"bytes,3,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// contains filtered or unexported fields
}

OpResponse with a common definition for the result of executing an operation through gRPC. Notice that in case of an error, the call must fail unless the operation is executed asynchronously and this message contains the result of a past operation.

func (*OpResponse) Descriptor deprecated

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

Deprecated: Use OpResponse.ProtoReflect.Descriptor instead.

func (*OpResponse) GetStatus

func (x *OpResponse) GetStatus() OpStatus

func (*OpResponse) GetStatusName

func (x *OpResponse) GetStatusName() string

func (*OpResponse) GetUserInfo

func (x *OpResponse) GetUserInfo() string

func (*OpResponse) ProtoMessage

func (*OpResponse) ProtoMessage()

func (*OpResponse) ProtoReflect

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

func (*OpResponse) Reset

func (x *OpResponse) Reset()

func (*OpResponse) String

func (x *OpResponse) String() string

func (*OpResponse) Validate

func (m *OpResponse) Validate() error

Validate checks the field values on OpResponse 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 (*OpResponse) ValidateAll added in v0.4.0

func (m *OpResponse) ValidateAll() error

ValidateAll checks the field values on OpResponse 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 OpResponseMultiError, or nil if none found.

type OpResponseMultiError added in v0.4.0

type OpResponseMultiError []error

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

func (OpResponseMultiError) AllErrors added in v0.4.0

func (m OpResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OpResponseMultiError) Error added in v0.4.0

func (m OpResponseMultiError) Error() string

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

type OpResponseValidationError

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

OpResponseValidationError is the validation error returned by OpResponse.Validate if the designated constraints aren't met.

func (OpResponseValidationError) Cause

func (e OpResponseValidationError) Cause() error

Cause function returns cause value.

func (OpResponseValidationError) Error

Error satisfies the builtin error interface

func (OpResponseValidationError) ErrorName

func (e OpResponseValidationError) ErrorName() string

ErrorName returns error name.

func (OpResponseValidationError) Field

Field function returns field value.

func (OpResponseValidationError) Key

Key function returns key value.

func (OpResponseValidationError) Reason

func (e OpResponseValidationError) Reason() string

Reason function returns reason value.

type OpStatus

type OpStatus int32

OpStatus enumeration defining the possible status of an operation.

const (
	// Unknown operation status indicates an error in the processing of the request as all operations should
	// have a determined status.
	OpStatus_UNKNOWN OpStatus = 0
	// Success indicates that the operation was completed successfully.
	OpStatus_SUCCESS OpStatus = 1
)

func (OpStatus) Descriptor

func (OpStatus) Descriptor() protoreflect.EnumDescriptor

func (OpStatus) Enum

func (x OpStatus) Enum() *OpStatus

func (OpStatus) EnumDescriptor deprecated

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

Deprecated: Use OpStatus.Descriptor instead.

func (OpStatus) Number

func (x OpStatus) Number() protoreflect.EnumNumber

func (OpStatus) String

func (x OpStatus) String() string

func (OpStatus) Type

type RemoveGenericRequest added in v0.4.0

type RemoveGenericRequest struct {

	// Name of the component.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

RemoveGenericRequest with the information required to identify an entity for removal.

func (*RemoveGenericRequest) Descriptor deprecated added in v0.4.0

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

Deprecated: Use RemoveGenericRequest.ProtoReflect.Descriptor instead.

func (*RemoveGenericRequest) GetName added in v0.4.0

func (x *RemoveGenericRequest) GetName() string

func (*RemoveGenericRequest) ProtoMessage added in v0.4.0

func (*RemoveGenericRequest) ProtoMessage()

func (*RemoveGenericRequest) ProtoReflect added in v0.4.0

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

func (*RemoveGenericRequest) Reset added in v0.4.0

func (x *RemoveGenericRequest) Reset()

func (*RemoveGenericRequest) String added in v0.4.0

func (x *RemoveGenericRequest) String() string

func (*RemoveGenericRequest) Validate added in v0.4.0

func (m *RemoveGenericRequest) Validate() error

Validate checks the field values on RemoveGenericRequest 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 (*RemoveGenericRequest) ValidateAll added in v0.4.0

func (m *RemoveGenericRequest) ValidateAll() error

ValidateAll checks the field values on RemoveGenericRequest 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 RemoveGenericRequestMultiError, or nil if none found.

type RemoveGenericRequestMultiError added in v0.4.0

type RemoveGenericRequestMultiError []error

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

func (RemoveGenericRequestMultiError) AllErrors added in v0.4.0

func (m RemoveGenericRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RemoveGenericRequestMultiError) Error added in v0.4.0

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

type RemoveGenericRequestValidationError added in v0.4.0

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

RemoveGenericRequestValidationError is the validation error returned by RemoveGenericRequest.Validate if the designated constraints aren't met.

func (RemoveGenericRequestValidationError) Cause added in v0.4.0

Cause function returns cause value.

func (RemoveGenericRequestValidationError) Error added in v0.4.0

Error satisfies the builtin error interface

func (RemoveGenericRequestValidationError) ErrorName added in v0.4.0

ErrorName returns error name.

func (RemoveGenericRequestValidationError) Field added in v0.4.0

Field function returns field value.

func (RemoveGenericRequestValidationError) Key added in v0.4.0

Key function returns key value.

func (RemoveGenericRequestValidationError) Reason added in v0.4.0

Reason function returns reason value.

type TokenResponse added in v0.2.0

type TokenResponse struct {

	// Token generated.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// RefreshToken.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// AccountName with the name of the account where the token is valid
	AccountName string `protobuf:"bytes,3,opt,name=account_name,json=accountName,proto3" json:"account_name,omitempty"`
	// EnvironmentName with the name of the account where the token is valid
	EnvironmentName string `protobuf:"bytes,4,opt,name=environment_name,json=environmentName,proto3" json:"environment_name,omitempty"`
	// PlatformUsername with the username associated with the customer making the login request as registered in the platform.
	PlatformUsername string `protobuf:"bytes,5,opt,name=platform_username,json=platformUsername,proto3" json:"platform_username,omitempty"`
	// contains filtered or unexported fields
}

TokenResponse is the message that contains the generated token and the refresh token.

func (*TokenResponse) Descriptor deprecated added in v0.2.0

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

Deprecated: Use TokenResponse.ProtoReflect.Descriptor instead.

func (*TokenResponse) GetAccountName added in v0.3.0

func (x *TokenResponse) GetAccountName() string

func (*TokenResponse) GetEnvironmentName added in v0.3.0

func (x *TokenResponse) GetEnvironmentName() string

func (*TokenResponse) GetPlatformUsername added in v0.6.0

func (x *TokenResponse) GetPlatformUsername() string

func (*TokenResponse) GetRefreshToken added in v0.2.0

func (x *TokenResponse) GetRefreshToken() string

func (*TokenResponse) GetToken added in v0.2.0

func (x *TokenResponse) GetToken() string

func (*TokenResponse) ProtoMessage added in v0.2.0

func (*TokenResponse) ProtoMessage()

func (*TokenResponse) ProtoReflect added in v0.2.0

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

func (*TokenResponse) Reset added in v0.2.0

func (x *TokenResponse) Reset()

func (*TokenResponse) String added in v0.2.0

func (x *TokenResponse) String() string

func (*TokenResponse) Validate added in v0.2.0

func (m *TokenResponse) Validate() error

Validate checks the field values on TokenResponse 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 (*TokenResponse) ValidateAll added in v0.4.0

func (m *TokenResponse) ValidateAll() error

ValidateAll checks the field values on TokenResponse 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 TokenResponseMultiError, or nil if none found.

type TokenResponseMultiError added in v0.4.0

type TokenResponseMultiError []error

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

func (TokenResponseMultiError) AllErrors added in v0.4.0

func (m TokenResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TokenResponseMultiError) Error added in v0.4.0

func (m TokenResponseMultiError) Error() string

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

type TokenResponseValidationError added in v0.2.0

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

TokenResponseValidationError is the validation error returned by TokenResponse.Validate if the designated constraints aren't met.

func (TokenResponseValidationError) Cause added in v0.2.0

Cause function returns cause value.

func (TokenResponseValidationError) Error added in v0.2.0

Error satisfies the builtin error interface

func (TokenResponseValidationError) ErrorName added in v0.2.0

func (e TokenResponseValidationError) ErrorName() string

ErrorName returns error name.

func (TokenResponseValidationError) Field added in v0.2.0

Field function returns field value.

func (TokenResponseValidationError) Key added in v0.2.0

Key function returns key value.

func (TokenResponseValidationError) Reason added in v0.2.0

Reason function returns reason value.

Jump to

Keyboard shortcuts

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