Documentation
¶
Overview ¶
Package metadata is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client APIClient) error
- func RegisterAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server APIServer) error
- func RegisterAPIServer(s grpc.ServiceRegistrar, srv APIServer)
- type APIClient
- type APIServer
- type ClusterPicker
- func (*ClusterPicker) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterPicker) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*ClusterPicker) ProtoMessage()
- func (x *ClusterPicker) ProtoReflect() protoreflect.Message
- func (x *ClusterPicker) Reset()
- func (x *ClusterPicker) String() string
- func (m *ClusterPicker) Validate() error
- func (m *ClusterPicker) ValidateAll() error
- type ClusterPickerMultiError
- type ClusterPickerValidationError
- func (e ClusterPickerValidationError) Cause() error
- func (e ClusterPickerValidationError) Error() string
- func (e ClusterPickerValidationError) ErrorName() string
- func (e ClusterPickerValidationError) Field() string
- func (e ClusterPickerValidationError) Key() bool
- func (e ClusterPickerValidationError) Reason() string
- type Edit
- func (*Edit) Descriptor() ([]byte, []int)deprecated
- func (x *Edit) GetAddKey() *Edit_AddKey
- func (x *Edit) GetBranch() *pfs.BranchPicker
- func (x *Edit) GetCluster() *ClusterPicker
- func (x *Edit) GetCommit() *pfs.CommitPicker
- func (x *Edit) GetDeleteKey() *Edit_DeleteKey
- func (x *Edit) GetEditKey() *Edit_EditKey
- func (m *Edit) GetOp() isEdit_Op
- func (x *Edit) GetPipeline() *pps.PipelinePicker
- func (x *Edit) GetProject() *pfs.ProjectPicker
- func (x *Edit) GetReplace() *Edit_Replace
- func (x *Edit) GetRepo() *pfs.RepoPicker
- func (m *Edit) GetTarget() isEdit_Target
- func (x *Edit) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*Edit) ProtoMessage()
- func (x *Edit) ProtoReflect() protoreflect.Message
- func (x *Edit) Reset()
- func (x *Edit) String() string
- func (m *Edit) Validate() error
- func (m *Edit) ValidateAll() error
- type EditMetadataRequest
- func (*EditMetadataRequest) Descriptor() ([]byte, []int)deprecated
- func (x *EditMetadataRequest) GetEdits() []*Edit
- func (x *EditMetadataRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*EditMetadataRequest) ProtoMessage()
- func (x *EditMetadataRequest) ProtoReflect() protoreflect.Message
- func (x *EditMetadataRequest) Reset()
- func (x *EditMetadataRequest) String() string
- func (m *EditMetadataRequest) Validate() error
- func (m *EditMetadataRequest) ValidateAll() error
- type EditMetadataRequestMultiError
- type EditMetadataRequestValidationError
- func (e EditMetadataRequestValidationError) Cause() error
- func (e EditMetadataRequestValidationError) Error() string
- func (e EditMetadataRequestValidationError) ErrorName() string
- func (e EditMetadataRequestValidationError) Field() string
- func (e EditMetadataRequestValidationError) Key() bool
- func (e EditMetadataRequestValidationError) Reason() string
- type EditMetadataResponse
- func (*EditMetadataResponse) Descriptor() ([]byte, []int)deprecated
- func (x *EditMetadataResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*EditMetadataResponse) ProtoMessage()
- func (x *EditMetadataResponse) ProtoReflect() protoreflect.Message
- func (x *EditMetadataResponse) Reset()
- func (x *EditMetadataResponse) String() string
- func (m *EditMetadataResponse) Validate() error
- func (m *EditMetadataResponse) ValidateAll() error
- type EditMetadataResponseMultiError
- type EditMetadataResponseValidationError
- func (e EditMetadataResponseValidationError) Cause() error
- func (e EditMetadataResponseValidationError) Error() string
- func (e EditMetadataResponseValidationError) ErrorName() string
- func (e EditMetadataResponseValidationError) Field() string
- func (e EditMetadataResponseValidationError) Key() bool
- func (e EditMetadataResponseValidationError) Reason() string
- type EditMultiError
- type EditValidationError
- type Edit_AddKey
- func (*Edit_AddKey) Descriptor() ([]byte, []int)deprecated
- func (x *Edit_AddKey) GetKey() string
- func (x *Edit_AddKey) GetValue() string
- func (x *Edit_AddKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*Edit_AddKey) ProtoMessage()
- func (x *Edit_AddKey) ProtoReflect() protoreflect.Message
- func (x *Edit_AddKey) Reset()
- func (x *Edit_AddKey) String() string
- func (m *Edit_AddKey) Validate() error
- func (m *Edit_AddKey) ValidateAll() error
- type Edit_AddKeyMultiError
- type Edit_AddKeyValidationError
- func (e Edit_AddKeyValidationError) Cause() error
- func (e Edit_AddKeyValidationError) Error() string
- func (e Edit_AddKeyValidationError) ErrorName() string
- func (e Edit_AddKeyValidationError) Field() string
- func (e Edit_AddKeyValidationError) Key() bool
- func (e Edit_AddKeyValidationError) Reason() string
- type Edit_AddKey_
- type Edit_Branch
- type Edit_Cluster
- type Edit_Commit
- type Edit_DeleteKey
- func (*Edit_DeleteKey) Descriptor() ([]byte, []int)deprecated
- func (x *Edit_DeleteKey) GetKey() string
- func (x *Edit_DeleteKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*Edit_DeleteKey) ProtoMessage()
- func (x *Edit_DeleteKey) ProtoReflect() protoreflect.Message
- func (x *Edit_DeleteKey) Reset()
- func (x *Edit_DeleteKey) String() string
- func (m *Edit_DeleteKey) Validate() error
- func (m *Edit_DeleteKey) ValidateAll() error
- type Edit_DeleteKeyMultiError
- type Edit_DeleteKeyValidationError
- func (e Edit_DeleteKeyValidationError) Cause() error
- func (e Edit_DeleteKeyValidationError) Error() string
- func (e Edit_DeleteKeyValidationError) ErrorName() string
- func (e Edit_DeleteKeyValidationError) Field() string
- func (e Edit_DeleteKeyValidationError) Key() bool
- func (e Edit_DeleteKeyValidationError) Reason() string
- type Edit_DeleteKey_
- type Edit_EditKey
- func (*Edit_EditKey) Descriptor() ([]byte, []int)deprecated
- func (x *Edit_EditKey) GetKey() string
- func (x *Edit_EditKey) GetValue() string
- func (x *Edit_EditKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*Edit_EditKey) ProtoMessage()
- func (x *Edit_EditKey) ProtoReflect() protoreflect.Message
- func (x *Edit_EditKey) Reset()
- func (x *Edit_EditKey) String() string
- func (m *Edit_EditKey) Validate() error
- func (m *Edit_EditKey) ValidateAll() error
- type Edit_EditKeyMultiError
- type Edit_EditKeyValidationError
- func (e Edit_EditKeyValidationError) Cause() error
- func (e Edit_EditKeyValidationError) Error() string
- func (e Edit_EditKeyValidationError) ErrorName() string
- func (e Edit_EditKeyValidationError) Field() string
- func (e Edit_EditKeyValidationError) Key() bool
- func (e Edit_EditKeyValidationError) Reason() string
- type Edit_EditKey_
- type Edit_Pipeline
- type Edit_Project
- type Edit_Replace
- func (*Edit_Replace) Descriptor() ([]byte, []int)deprecated
- func (x *Edit_Replace) GetReplacement() map[string]string
- func (x *Edit_Replace) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*Edit_Replace) ProtoMessage()
- func (x *Edit_Replace) ProtoReflect() protoreflect.Message
- func (x *Edit_Replace) Reset()
- func (x *Edit_Replace) String() string
- func (m *Edit_Replace) Validate() error
- func (m *Edit_Replace) ValidateAll() error
- type Edit_ReplaceMultiError
- type Edit_ReplaceValidationError
- func (e Edit_ReplaceValidationError) Cause() error
- func (e Edit_ReplaceValidationError) Error() string
- func (e Edit_ReplaceValidationError) ErrorName() string
- func (e Edit_ReplaceValidationError) Field() string
- func (e Edit_ReplaceValidationError) Key() bool
- func (e Edit_ReplaceValidationError) Reason() string
- type Edit_Replace_
- type Edit_Repo
- type UnimplementedAPIServer
- type UnsafeAPIServer
Constants ¶
const (
API_EditMetadata_FullMethodName = "/metadata.API/EditMetadata"
)
Variables ¶
var API_ServiceDesc = grpc.ServiceDesc{ ServiceName: "metadata.API", HandlerType: (*APIServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "EditMetadata", Handler: _API_EditMetadata_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "metadata/metadata.proto", }
API_ServiceDesc is the grpc.ServiceDesc for API service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_metadata_metadata_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAPIHandler ¶
RegisterAPIHandler registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterAPIHandlerClient ¶
RegisterAPIHandlerClient registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "APIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "APIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "APIClient" to call the correct interceptors.
func RegisterAPIHandlerFromEndpoint ¶
func RegisterAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterAPIHandlerFromEndpoint is same as RegisterAPIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterAPIHandlerServer ¶
RegisterAPIHandlerServer registers the http handlers for service API to "mux". UnaryRPC :call APIServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAPIHandlerFromEndpoint instead.
func RegisterAPIServer ¶
func RegisterAPIServer(s grpc.ServiceRegistrar, srv APIServer)
Types ¶
type APIClient ¶
type APIClient interface { // EditMetadata edits metadata according to the request. All edits are applied atomically at // once. All edits are attempted, but any failing edit fails the entire request. EditMetadata(ctx context.Context, in *EditMetadataRequest, opts ...grpc.CallOption) (*EditMetadataResponse, error) }
APIClient is the client API for API service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewAPIClient ¶
func NewAPIClient(cc grpc.ClientConnInterface) APIClient
type APIServer ¶
type APIServer interface { // EditMetadata edits metadata according to the request. All edits are applied atomically at // once. All edits are attempted, but any failing edit fails the entire request. EditMetadata(context.Context, *EditMetadataRequest) (*EditMetadataResponse, error) // contains filtered or unexported methods }
APIServer is the server API for API service. All implementations must embed UnimplementedAPIServer for forward compatibility
type ClusterPicker ¶
type ClusterPicker struct {
// contains filtered or unexported fields
}
ClusterPicker selects a cluster. Since clusters will never "cascade", there is only one cluster that can be selected, the one running this API server.
func (*ClusterPicker) Descriptor
deprecated
func (*ClusterPicker) Descriptor() ([]byte, []int)
Deprecated: Use ClusterPicker.ProtoReflect.Descriptor instead.
func (*ClusterPicker) MarshalLogObject ¶
func (x *ClusterPicker) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*ClusterPicker) ProtoMessage ¶
func (*ClusterPicker) ProtoMessage()
func (*ClusterPicker) ProtoReflect ¶
func (x *ClusterPicker) ProtoReflect() protoreflect.Message
func (*ClusterPicker) Reset ¶
func (x *ClusterPicker) Reset()
func (*ClusterPicker) String ¶
func (x *ClusterPicker) String() string
func (*ClusterPicker) Validate ¶
func (m *ClusterPicker) Validate() error
Validate checks the field values on ClusterPicker 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 (*ClusterPicker) ValidateAll ¶
func (m *ClusterPicker) ValidateAll() error
ValidateAll checks the field values on ClusterPicker 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 ClusterPickerMultiError, or nil if none found.
type ClusterPickerMultiError ¶
type ClusterPickerMultiError []error
ClusterPickerMultiError is an error wrapping multiple validation errors returned by ClusterPicker.ValidateAll() if the designated constraints aren't met.
func (ClusterPickerMultiError) AllErrors ¶
func (m ClusterPickerMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ClusterPickerMultiError) Error ¶
func (m ClusterPickerMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ClusterPickerValidationError ¶
type ClusterPickerValidationError struct {
// contains filtered or unexported fields
}
ClusterPickerValidationError is the validation error returned by ClusterPicker.Validate if the designated constraints aren't met.
func (ClusterPickerValidationError) Cause ¶
func (e ClusterPickerValidationError) Cause() error
Cause function returns cause value.
func (ClusterPickerValidationError) Error ¶
func (e ClusterPickerValidationError) Error() string
Error satisfies the builtin error interface
func (ClusterPickerValidationError) ErrorName ¶
func (e ClusterPickerValidationError) ErrorName() string
ErrorName returns error name.
func (ClusterPickerValidationError) Field ¶
func (e ClusterPickerValidationError) Field() string
Field function returns field value.
func (ClusterPickerValidationError) Key ¶
func (e ClusterPickerValidationError) Key() bool
Key function returns key value.
func (ClusterPickerValidationError) Reason ¶
func (e ClusterPickerValidationError) Reason() string
Reason function returns reason value.
type Edit ¶
type Edit struct { // target is the object whose metadata will be edited. // // Types that are assignable to Target: // // *Edit_Project // *Edit_Commit // *Edit_Branch // *Edit_Repo // *Edit_Cluster // *Edit_Pipeline Target isEdit_Target `protobuf_oneof:"target"` // op is the operation to perform on the target object's metadata. // // Types that are assignable to Op: // // *Edit_Replace_ // *Edit_AddKey_ // *Edit_EditKey_ // *Edit_DeleteKey_ Op isEdit_Op `protobuf_oneof:"op"` // contains filtered or unexported fields }
Edit represents editing one piece of metadata.
func (*Edit) Descriptor
deprecated
func (*Edit) GetAddKey ¶
func (x *Edit) GetAddKey() *Edit_AddKey
func (*Edit) GetBranch ¶
func (x *Edit) GetBranch() *pfs.BranchPicker
func (*Edit) GetCluster ¶
func (x *Edit) GetCluster() *ClusterPicker
func (*Edit) GetCommit ¶
func (x *Edit) GetCommit() *pfs.CommitPicker
func (*Edit) GetDeleteKey ¶
func (x *Edit) GetDeleteKey() *Edit_DeleteKey
func (*Edit) GetEditKey ¶
func (x *Edit) GetEditKey() *Edit_EditKey
func (*Edit) GetPipeline ¶ added in v2.11.0
func (x *Edit) GetPipeline() *pps.PipelinePicker
func (*Edit) GetProject ¶
func (x *Edit) GetProject() *pfs.ProjectPicker
func (*Edit) GetReplace ¶
func (x *Edit) GetReplace() *Edit_Replace
func (*Edit) GetRepo ¶
func (x *Edit) GetRepo() *pfs.RepoPicker
func (*Edit) MarshalLogObject ¶
func (x *Edit) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*Edit) ProtoMessage ¶
func (*Edit) ProtoMessage()
func (*Edit) ProtoReflect ¶
func (x *Edit) ProtoReflect() protoreflect.Message
func (*Edit) Validate ¶
Validate checks the field values on Edit 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 (*Edit) ValidateAll ¶
ValidateAll checks the field values on Edit 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 EditMultiError, or nil if none found.
type EditMetadataRequest ¶
type EditMetadataRequest struct { // edits is the ordered list of metadata edits to perform. Edits []*Edit `protobuf:"bytes,1,rep,name=edits,proto3" json:"edits,omitempty"` // contains filtered or unexported fields }
EditMetadataRequest is a sequence of edits to apply to metadata.
func (*EditMetadataRequest) Descriptor
deprecated
func (*EditMetadataRequest) Descriptor() ([]byte, []int)
Deprecated: Use EditMetadataRequest.ProtoReflect.Descriptor instead.
func (*EditMetadataRequest) GetEdits ¶
func (x *EditMetadataRequest) GetEdits() []*Edit
func (*EditMetadataRequest) MarshalLogObject ¶
func (x *EditMetadataRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*EditMetadataRequest) ProtoMessage ¶
func (*EditMetadataRequest) ProtoMessage()
func (*EditMetadataRequest) ProtoReflect ¶
func (x *EditMetadataRequest) ProtoReflect() protoreflect.Message
func (*EditMetadataRequest) Reset ¶
func (x *EditMetadataRequest) Reset()
func (*EditMetadataRequest) String ¶
func (x *EditMetadataRequest) String() string
func (*EditMetadataRequest) Validate ¶
func (m *EditMetadataRequest) Validate() error
Validate checks the field values on EditMetadataRequest 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 (*EditMetadataRequest) ValidateAll ¶
func (m *EditMetadataRequest) ValidateAll() error
ValidateAll checks the field values on EditMetadataRequest 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 EditMetadataRequestMultiError, or nil if none found.
type EditMetadataRequestMultiError ¶
type EditMetadataRequestMultiError []error
EditMetadataRequestMultiError is an error wrapping multiple validation errors returned by EditMetadataRequest.ValidateAll() if the designated constraints aren't met.
func (EditMetadataRequestMultiError) AllErrors ¶
func (m EditMetadataRequestMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (EditMetadataRequestMultiError) Error ¶
func (m EditMetadataRequestMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type EditMetadataRequestValidationError ¶
type EditMetadataRequestValidationError struct {
// contains filtered or unexported fields
}
EditMetadataRequestValidationError is the validation error returned by EditMetadataRequest.Validate if the designated constraints aren't met.
func (EditMetadataRequestValidationError) Cause ¶
func (e EditMetadataRequestValidationError) Cause() error
Cause function returns cause value.
func (EditMetadataRequestValidationError) Error ¶
func (e EditMetadataRequestValidationError) Error() string
Error satisfies the builtin error interface
func (EditMetadataRequestValidationError) ErrorName ¶
func (e EditMetadataRequestValidationError) ErrorName() string
ErrorName returns error name.
func (EditMetadataRequestValidationError) Field ¶
func (e EditMetadataRequestValidationError) Field() string
Field function returns field value.
func (EditMetadataRequestValidationError) Key ¶
func (e EditMetadataRequestValidationError) Key() bool
Key function returns key value.
func (EditMetadataRequestValidationError) Reason ¶
func (e EditMetadataRequestValidationError) Reason() string
Reason function returns reason value.
type EditMetadataResponse ¶
type EditMetadataResponse struct {
// contains filtered or unexported fields
}
EditMetadataResponse is the result of editing metadata.
func (*EditMetadataResponse) Descriptor
deprecated
func (*EditMetadataResponse) Descriptor() ([]byte, []int)
Deprecated: Use EditMetadataResponse.ProtoReflect.Descriptor instead.
func (*EditMetadataResponse) MarshalLogObject ¶
func (x *EditMetadataResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*EditMetadataResponse) ProtoMessage ¶
func (*EditMetadataResponse) ProtoMessage()
func (*EditMetadataResponse) ProtoReflect ¶
func (x *EditMetadataResponse) ProtoReflect() protoreflect.Message
func (*EditMetadataResponse) Reset ¶
func (x *EditMetadataResponse) Reset()
func (*EditMetadataResponse) String ¶
func (x *EditMetadataResponse) String() string
func (*EditMetadataResponse) Validate ¶
func (m *EditMetadataResponse) Validate() error
Validate checks the field values on EditMetadataResponse 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 (*EditMetadataResponse) ValidateAll ¶
func (m *EditMetadataResponse) ValidateAll() error
ValidateAll checks the field values on EditMetadataResponse 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 EditMetadataResponseMultiError, or nil if none found.
type EditMetadataResponseMultiError ¶
type EditMetadataResponseMultiError []error
EditMetadataResponseMultiError is an error wrapping multiple validation errors returned by EditMetadataResponse.ValidateAll() if the designated constraints aren't met.
func (EditMetadataResponseMultiError) AllErrors ¶
func (m EditMetadataResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (EditMetadataResponseMultiError) Error ¶
func (m EditMetadataResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type EditMetadataResponseValidationError ¶
type EditMetadataResponseValidationError struct {
// contains filtered or unexported fields
}
EditMetadataResponseValidationError is the validation error returned by EditMetadataResponse.Validate if the designated constraints aren't met.
func (EditMetadataResponseValidationError) Cause ¶
func (e EditMetadataResponseValidationError) Cause() error
Cause function returns cause value.
func (EditMetadataResponseValidationError) Error ¶
func (e EditMetadataResponseValidationError) Error() string
Error satisfies the builtin error interface
func (EditMetadataResponseValidationError) ErrorName ¶
func (e EditMetadataResponseValidationError) ErrorName() string
ErrorName returns error name.
func (EditMetadataResponseValidationError) Field ¶
func (e EditMetadataResponseValidationError) Field() string
Field function returns field value.
func (EditMetadataResponseValidationError) Key ¶
func (e EditMetadataResponseValidationError) Key() bool
Key function returns key value.
func (EditMetadataResponseValidationError) Reason ¶
func (e EditMetadataResponseValidationError) Reason() string
Reason function returns reason value.
type EditMultiError ¶
type EditMultiError []error
EditMultiError is an error wrapping multiple validation errors returned by Edit.ValidateAll() if the designated constraints aren't met.
func (EditMultiError) AllErrors ¶
func (m EditMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (EditMultiError) Error ¶
func (m EditMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type EditValidationError ¶
type EditValidationError struct {
// contains filtered or unexported fields
}
EditValidationError is the validation error returned by Edit.Validate if the designated constraints aren't met.
func (EditValidationError) Cause ¶
func (e EditValidationError) Cause() error
Cause function returns cause value.
func (EditValidationError) Error ¶
func (e EditValidationError) Error() string
Error satisfies the builtin error interface
func (EditValidationError) ErrorName ¶
func (e EditValidationError) ErrorName() string
ErrorName returns error name.
func (EditValidationError) Field ¶
func (e EditValidationError) Field() string
Field function returns field value.
func (EditValidationError) Key ¶
func (e EditValidationError) Key() bool
Key function returns key value.
func (EditValidationError) Reason ¶
func (e EditValidationError) Reason() string
Reason function returns reason value.
type Edit_AddKey ¶
type Edit_AddKey struct { // key is the metadata key to add. It may not be the empty string. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // value is the value to assign to the metadata key. Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
AddKey is an operation that adds a new metadata key.
func (*Edit_AddKey) Descriptor
deprecated
func (*Edit_AddKey) Descriptor() ([]byte, []int)
Deprecated: Use Edit_AddKey.ProtoReflect.Descriptor instead.
func (*Edit_AddKey) GetKey ¶
func (x *Edit_AddKey) GetKey() string
func (*Edit_AddKey) GetValue ¶
func (x *Edit_AddKey) GetValue() string
func (*Edit_AddKey) MarshalLogObject ¶
func (x *Edit_AddKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*Edit_AddKey) ProtoMessage ¶
func (*Edit_AddKey) ProtoMessage()
func (*Edit_AddKey) ProtoReflect ¶
func (x *Edit_AddKey) ProtoReflect() protoreflect.Message
func (*Edit_AddKey) Reset ¶
func (x *Edit_AddKey) Reset()
func (*Edit_AddKey) String ¶
func (x *Edit_AddKey) String() string
func (*Edit_AddKey) Validate ¶
func (m *Edit_AddKey) Validate() error
Validate checks the field values on Edit_AddKey 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 (*Edit_AddKey) ValidateAll ¶
func (m *Edit_AddKey) ValidateAll() error
ValidateAll checks the field values on Edit_AddKey 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 Edit_AddKeyMultiError, or nil if none found.
type Edit_AddKeyMultiError ¶
type Edit_AddKeyMultiError []error
Edit_AddKeyMultiError is an error wrapping multiple validation errors returned by Edit_AddKey.ValidateAll() if the designated constraints aren't met.
func (Edit_AddKeyMultiError) AllErrors ¶
func (m Edit_AddKeyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (Edit_AddKeyMultiError) Error ¶
func (m Edit_AddKeyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type Edit_AddKeyValidationError ¶
type Edit_AddKeyValidationError struct {
// contains filtered or unexported fields
}
Edit_AddKeyValidationError is the validation error returned by Edit_AddKey.Validate if the designated constraints aren't met.
func (Edit_AddKeyValidationError) Cause ¶
func (e Edit_AddKeyValidationError) Cause() error
Cause function returns cause value.
func (Edit_AddKeyValidationError) Error ¶
func (e Edit_AddKeyValidationError) Error() string
Error satisfies the builtin error interface
func (Edit_AddKeyValidationError) ErrorName ¶
func (e Edit_AddKeyValidationError) ErrorName() string
ErrorName returns error name.
func (Edit_AddKeyValidationError) Field ¶
func (e Edit_AddKeyValidationError) Field() string
Field function returns field value.
func (Edit_AddKeyValidationError) Key ¶
func (e Edit_AddKeyValidationError) Key() bool
Key function returns key value.
func (Edit_AddKeyValidationError) Reason ¶
func (e Edit_AddKeyValidationError) Reason() string
Reason function returns reason value.
type Edit_AddKey_ ¶
type Edit_AddKey_ struct { // add_key adds a new key to the target object's metadata. AddKey *Edit_AddKey `protobuf:"bytes,11,opt,name=add_key,json=addKey,proto3,oneof"` }
type Edit_Branch ¶
type Edit_Branch struct { // branch targets a branch's metadata. Branch *pfs.BranchPicker `protobuf:"bytes,3,opt,name=branch,proto3,oneof"` }
type Edit_Cluster ¶
type Edit_Cluster struct { // cluster targets the cluster's metadata. Cluster *ClusterPicker `protobuf:"bytes,5,opt,name=cluster,proto3,oneof"` }
type Edit_Commit ¶
type Edit_Commit struct { // commit targets a commit's metadata. Commit *pfs.CommitPicker `protobuf:"bytes,2,opt,name=commit,proto3,oneof"` }
type Edit_DeleteKey ¶
type Edit_DeleteKey struct { // key is the metadata key to remove. It may not be the empty string. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
DeleteKey is an operation that removes a metadata key.
func (*Edit_DeleteKey) Descriptor
deprecated
func (*Edit_DeleteKey) Descriptor() ([]byte, []int)
Deprecated: Use Edit_DeleteKey.ProtoReflect.Descriptor instead.
func (*Edit_DeleteKey) GetKey ¶
func (x *Edit_DeleteKey) GetKey() string
func (*Edit_DeleteKey) MarshalLogObject ¶
func (x *Edit_DeleteKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*Edit_DeleteKey) ProtoMessage ¶
func (*Edit_DeleteKey) ProtoMessage()
func (*Edit_DeleteKey) ProtoReflect ¶
func (x *Edit_DeleteKey) ProtoReflect() protoreflect.Message
func (*Edit_DeleteKey) Reset ¶
func (x *Edit_DeleteKey) Reset()
func (*Edit_DeleteKey) String ¶
func (x *Edit_DeleteKey) String() string
func (*Edit_DeleteKey) Validate ¶
func (m *Edit_DeleteKey) Validate() error
Validate checks the field values on Edit_DeleteKey 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 (*Edit_DeleteKey) ValidateAll ¶
func (m *Edit_DeleteKey) ValidateAll() error
ValidateAll checks the field values on Edit_DeleteKey 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 Edit_DeleteKeyMultiError, or nil if none found.
type Edit_DeleteKeyMultiError ¶
type Edit_DeleteKeyMultiError []error
Edit_DeleteKeyMultiError is an error wrapping multiple validation errors returned by Edit_DeleteKey.ValidateAll() if the designated constraints aren't met.
func (Edit_DeleteKeyMultiError) AllErrors ¶
func (m Edit_DeleteKeyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (Edit_DeleteKeyMultiError) Error ¶
func (m Edit_DeleteKeyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type Edit_DeleteKeyValidationError ¶
type Edit_DeleteKeyValidationError struct {
// contains filtered or unexported fields
}
Edit_DeleteKeyValidationError is the validation error returned by Edit_DeleteKey.Validate if the designated constraints aren't met.
func (Edit_DeleteKeyValidationError) Cause ¶
func (e Edit_DeleteKeyValidationError) Cause() error
Cause function returns cause value.
func (Edit_DeleteKeyValidationError) Error ¶
func (e Edit_DeleteKeyValidationError) Error() string
Error satisfies the builtin error interface
func (Edit_DeleteKeyValidationError) ErrorName ¶
func (e Edit_DeleteKeyValidationError) ErrorName() string
ErrorName returns error name.
func (Edit_DeleteKeyValidationError) Field ¶
func (e Edit_DeleteKeyValidationError) Field() string
Field function returns field value.
func (Edit_DeleteKeyValidationError) Key ¶
func (e Edit_DeleteKeyValidationError) Key() bool
Key function returns key value.
func (Edit_DeleteKeyValidationError) Reason ¶
func (e Edit_DeleteKeyValidationError) Reason() string
Reason function returns reason value.
type Edit_DeleteKey_ ¶
type Edit_DeleteKey_ struct { // delete_key removes a key from the target object's metadata. DeleteKey *Edit_DeleteKey `protobuf:"bytes,13,opt,name=delete_key,json=deleteKey,proto3,oneof"` }
type Edit_EditKey ¶
type Edit_EditKey struct { // key is the metadata key to change or add. It may not be the empty string. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // value is the value to assign to the metadata key. Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
EditKey is an operation that changes or adds a metadata key.
func (*Edit_EditKey) Descriptor
deprecated
func (*Edit_EditKey) Descriptor() ([]byte, []int)
Deprecated: Use Edit_EditKey.ProtoReflect.Descriptor instead.
func (*Edit_EditKey) GetKey ¶
func (x *Edit_EditKey) GetKey() string
func (*Edit_EditKey) GetValue ¶
func (x *Edit_EditKey) GetValue() string
func (*Edit_EditKey) MarshalLogObject ¶
func (x *Edit_EditKey) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*Edit_EditKey) ProtoMessage ¶
func (*Edit_EditKey) ProtoMessage()
func (*Edit_EditKey) ProtoReflect ¶
func (x *Edit_EditKey) ProtoReflect() protoreflect.Message
func (*Edit_EditKey) Reset ¶
func (x *Edit_EditKey) Reset()
func (*Edit_EditKey) String ¶
func (x *Edit_EditKey) String() string
func (*Edit_EditKey) Validate ¶
func (m *Edit_EditKey) Validate() error
Validate checks the field values on Edit_EditKey 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 (*Edit_EditKey) ValidateAll ¶
func (m *Edit_EditKey) ValidateAll() error
ValidateAll checks the field values on Edit_EditKey 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 Edit_EditKeyMultiError, or nil if none found.
type Edit_EditKeyMultiError ¶
type Edit_EditKeyMultiError []error
Edit_EditKeyMultiError is an error wrapping multiple validation errors returned by Edit_EditKey.ValidateAll() if the designated constraints aren't met.
func (Edit_EditKeyMultiError) AllErrors ¶
func (m Edit_EditKeyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (Edit_EditKeyMultiError) Error ¶
func (m Edit_EditKeyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type Edit_EditKeyValidationError ¶
type Edit_EditKeyValidationError struct {
// contains filtered or unexported fields
}
Edit_EditKeyValidationError is the validation error returned by Edit_EditKey.Validate if the designated constraints aren't met.
func (Edit_EditKeyValidationError) Cause ¶
func (e Edit_EditKeyValidationError) Cause() error
Cause function returns cause value.
func (Edit_EditKeyValidationError) Error ¶
func (e Edit_EditKeyValidationError) Error() string
Error satisfies the builtin error interface
func (Edit_EditKeyValidationError) ErrorName ¶
func (e Edit_EditKeyValidationError) ErrorName() string
ErrorName returns error name.
func (Edit_EditKeyValidationError) Field ¶
func (e Edit_EditKeyValidationError) Field() string
Field function returns field value.
func (Edit_EditKeyValidationError) Key ¶
func (e Edit_EditKeyValidationError) Key() bool
Key function returns key value.
func (Edit_EditKeyValidationError) Reason ¶
func (e Edit_EditKeyValidationError) Reason() string
Reason function returns reason value.
type Edit_EditKey_ ¶
type Edit_EditKey_ struct { // edit_key adds or changes a key in the target object's metadata. EditKey *Edit_EditKey `protobuf:"bytes,12,opt,name=edit_key,json=editKey,proto3,oneof"` }
type Edit_Pipeline ¶ added in v2.11.0
type Edit_Pipeline struct { // pipeline targets a pipeline. Pipeline *pps.PipelinePicker `protobuf:"bytes,6,opt,name=pipeline,proto3,oneof"` }
type Edit_Project ¶
type Edit_Project struct { // project targets a named project's metadata. Project *pfs.ProjectPicker `protobuf:"bytes,1,opt,name=project,proto3,oneof"` }
type Edit_Replace ¶
type Edit_Replace struct { // replacement is the map to replace the object's metadata with. Replacement map[string]string `` /* 163-byte string literal not displayed */ // contains filtered or unexported fields }
Replace is an operation that replaces metadata.
func (*Edit_Replace) Descriptor
deprecated
func (*Edit_Replace) Descriptor() ([]byte, []int)
Deprecated: Use Edit_Replace.ProtoReflect.Descriptor instead.
func (*Edit_Replace) GetReplacement ¶
func (x *Edit_Replace) GetReplacement() map[string]string
func (*Edit_Replace) MarshalLogObject ¶
func (x *Edit_Replace) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*Edit_Replace) ProtoMessage ¶
func (*Edit_Replace) ProtoMessage()
func (*Edit_Replace) ProtoReflect ¶
func (x *Edit_Replace) ProtoReflect() protoreflect.Message
func (*Edit_Replace) Reset ¶
func (x *Edit_Replace) Reset()
func (*Edit_Replace) String ¶
func (x *Edit_Replace) String() string
func (*Edit_Replace) Validate ¶
func (m *Edit_Replace) Validate() error
Validate checks the field values on Edit_Replace 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 (*Edit_Replace) ValidateAll ¶
func (m *Edit_Replace) ValidateAll() error
ValidateAll checks the field values on Edit_Replace 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 Edit_ReplaceMultiError, or nil if none found.
type Edit_ReplaceMultiError ¶
type Edit_ReplaceMultiError []error
Edit_ReplaceMultiError is an error wrapping multiple validation errors returned by Edit_Replace.ValidateAll() if the designated constraints aren't met.
func (Edit_ReplaceMultiError) AllErrors ¶
func (m Edit_ReplaceMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (Edit_ReplaceMultiError) Error ¶
func (m Edit_ReplaceMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type Edit_ReplaceValidationError ¶
type Edit_ReplaceValidationError struct {
// contains filtered or unexported fields
}
Edit_ReplaceValidationError is the validation error returned by Edit_Replace.Validate if the designated constraints aren't met.
func (Edit_ReplaceValidationError) Cause ¶
func (e Edit_ReplaceValidationError) Cause() error
Cause function returns cause value.
func (Edit_ReplaceValidationError) Error ¶
func (e Edit_ReplaceValidationError) Error() string
Error satisfies the builtin error interface
func (Edit_ReplaceValidationError) ErrorName ¶
func (e Edit_ReplaceValidationError) ErrorName() string
ErrorName returns error name.
func (Edit_ReplaceValidationError) Field ¶
func (e Edit_ReplaceValidationError) Field() string
Field function returns field value.
func (Edit_ReplaceValidationError) Key ¶
func (e Edit_ReplaceValidationError) Key() bool
Key function returns key value.
func (Edit_ReplaceValidationError) Reason ¶
func (e Edit_ReplaceValidationError) Reason() string
Reason function returns reason value.
type Edit_Replace_ ¶
type Edit_Replace_ struct { // replace replaces a target's metadata with a new metadata mapping. Replace *Edit_Replace `protobuf:"bytes,10,opt,name=replace,proto3,oneof"` }
type Edit_Repo ¶
type Edit_Repo struct { // repo targets a repo's metadata. Repo *pfs.RepoPicker `protobuf:"bytes,4,opt,name=repo,proto3,oneof"` }
type UnimplementedAPIServer ¶
type UnimplementedAPIServer struct { }
UnimplementedAPIServer must be embedded to have forward compatible implementations.
func (UnimplementedAPIServer) EditMetadata ¶
func (UnimplementedAPIServer) EditMetadata(context.Context, *EditMetadataRequest) (*EditMetadataResponse, error)
type UnsafeAPIServer ¶
type UnsafeAPIServer interface {
// contains filtered or unexported methods
}
UnsafeAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to APIServer will result in compilation errors.