Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterNodeServiceServer(s grpc.ServiceRegistrar, srv NodeServiceServer)
- type ArtifactType
- func (ArtifactType) Descriptor() protoreflect.EnumDescriptor
- func (x ArtifactType) Enum() *ArtifactType
- func (ArtifactType) EnumDescriptor() ([]byte, []int)deprecated
- func (x ArtifactType) Number() protoreflect.EnumNumber
- func (x ArtifactType) String() string
- func (ArtifactType) Type() protoreflect.EnumType
- type DownloadArtifactRequest
- func (*DownloadArtifactRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DownloadArtifactRequest) GetEnvironment() EnvironmentName
- func (x *DownloadArtifactRequest) GetId() string
- func (x *DownloadArtifactRequest) GetType() ArtifactType
- func (*DownloadArtifactRequest) ProtoMessage()
- func (x *DownloadArtifactRequest) ProtoReflect() protoreflect.Message
- func (x *DownloadArtifactRequest) Reset()
- func (x *DownloadArtifactRequest) String() string
- type DownloadArtifactResponse
- func (*DownloadArtifactResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DownloadArtifactResponse) GetExpiry() *timestamppb.Timestamp
- func (x *DownloadArtifactResponse) GetUrl() string
- func (*DownloadArtifactResponse) ProtoMessage()
- func (x *DownloadArtifactResponse) ProtoReflect() protoreflect.Message
- func (x *DownloadArtifactResponse) Reset()
- func (x *DownloadArtifactResponse) String() string
- type EnvironmentName
- func (EnvironmentName) Descriptor() protoreflect.EnumDescriptor
- func (x EnvironmentName) Enum() *EnvironmentName
- func (EnvironmentName) EnumDescriptor() ([]byte, []int)deprecated
- func (x EnvironmentName) Number() protoreflect.EnumNumber
- func (x EnvironmentName) String() string
- func (EnvironmentName) Type() protoreflect.EnumType
- type NodeServiceClient
- type NodeServiceServer
- type UnimplementedNodeServiceServer
- type UnsafeNodeServiceServer
Constants ¶
const (
NodeService_DownloadArtifact_FullMethodName = "/node.v1.NodeService/DownloadArtifact"
)
Variables ¶
var ( ArtifactType_name = map[int32]string{ 0: "ARTIFACT_TYPE_UNSPECIFIED", 1: "ARTIFACT_TYPE_BINARY", 2: "ARTIFACT_TYPE_CONFIG", } ArtifactType_value = map[string]int32{ "ARTIFACT_TYPE_UNSPECIFIED": 0, "ARTIFACT_TYPE_BINARY": 1, "ARTIFACT_TYPE_CONFIG": 2, } )
Enum value maps for ArtifactType.
var ( EnvironmentName_name = map[int32]string{ 0: "ENVIRONMENT_NAME_UNSPECIFIED", 1: "PRODUCTION_MAINNET", 2: "PRODUCTION_TESTNET", } EnvironmentName_value = map[string]int32{ "ENVIRONMENT_NAME_UNSPECIFIED": 0, "PRODUCTION_MAINNET": 1, "PRODUCTION_TESTNET": 2, } )
Enum value maps for EnvironmentName.
var File_node_v1_node_service_proto protoreflect.FileDescriptor
var NodeService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "node.v1.NodeService", HandlerType: (*NodeServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "DownloadArtifact", Handler: _NodeService_DownloadArtifact_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "node/v1/node_service.proto", }
NodeService_ServiceDesc is the grpc.ServiceDesc for NodeService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterNodeServiceServer ¶
func RegisterNodeServiceServer(s grpc.ServiceRegistrar, srv NodeServiceServer)
Types ¶
type ArtifactType ¶
type ArtifactType int32
const ( ArtifactType_ARTIFACT_TYPE_UNSPECIFIED ArtifactType = 0 // Unspecified artifact type ArtifactType_ARTIFACT_TYPE_BINARY ArtifactType = 1 // Workflow binary artifact ArtifactType_ARTIFACT_TYPE_CONFIG ArtifactType = 2 // Workflow configuration artifact )
func (ArtifactType) Descriptor ¶
func (ArtifactType) Descriptor() protoreflect.EnumDescriptor
func (ArtifactType) Enum ¶
func (x ArtifactType) Enum() *ArtifactType
func (ArtifactType) EnumDescriptor
deprecated
func (ArtifactType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ArtifactType.Descriptor instead.
func (ArtifactType) Number ¶
func (x ArtifactType) Number() protoreflect.EnumNumber
func (ArtifactType) String ¶
func (x ArtifactType) String() string
func (ArtifactType) Type ¶
func (ArtifactType) Type() protoreflect.EnumType
type DownloadArtifactRequest ¶
type DownloadArtifactRequest struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // ID of the artifact to download
Type ArtifactType `protobuf:"varint,2,opt,name=type,proto3,enum=node.v1.ArtifactType" json:"type,omitempty"` // Type of the artifact to download
Environment EnvironmentName `protobuf:"varint,3,opt,name=environment,proto3,enum=node.v1.EnvironmentName" json:"environment,omitempty"` // Environment of the artifact to download
// contains filtered or unexported fields
}
func (*DownloadArtifactRequest) Descriptor
deprecated
func (*DownloadArtifactRequest) Descriptor() ([]byte, []int)
Deprecated: Use DownloadArtifactRequest.ProtoReflect.Descriptor instead.
func (*DownloadArtifactRequest) GetEnvironment ¶
func (x *DownloadArtifactRequest) GetEnvironment() EnvironmentName
func (*DownloadArtifactRequest) GetId ¶
func (x *DownloadArtifactRequest) GetId() string
func (*DownloadArtifactRequest) GetType ¶
func (x *DownloadArtifactRequest) GetType() ArtifactType
func (*DownloadArtifactRequest) ProtoMessage ¶
func (*DownloadArtifactRequest) ProtoMessage()
func (*DownloadArtifactRequest) ProtoReflect ¶
func (x *DownloadArtifactRequest) ProtoReflect() protoreflect.Message
func (*DownloadArtifactRequest) Reset ¶
func (x *DownloadArtifactRequest) Reset()
func (*DownloadArtifactRequest) String ¶
func (x *DownloadArtifactRequest) String() string
type DownloadArtifactResponse ¶ added in v0.2.0
type DownloadArtifactResponse struct {
Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` // The presigned GET URL for downloading
Expiry *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expiry,proto3" json:"expiry,omitempty"` // Expiration time of the presigned URL
// contains filtered or unexported fields
}
func (*DownloadArtifactResponse) Descriptor
deprecated
added in
v0.2.0
func (*DownloadArtifactResponse) Descriptor() ([]byte, []int)
Deprecated: Use DownloadArtifactResponse.ProtoReflect.Descriptor instead.
func (*DownloadArtifactResponse) GetExpiry ¶ added in v0.2.0
func (x *DownloadArtifactResponse) GetExpiry() *timestamppb.Timestamp
func (*DownloadArtifactResponse) GetUrl ¶ added in v0.2.0
func (x *DownloadArtifactResponse) GetUrl() string
func (*DownloadArtifactResponse) ProtoMessage ¶ added in v0.2.0
func (*DownloadArtifactResponse) ProtoMessage()
func (*DownloadArtifactResponse) ProtoReflect ¶ added in v0.2.0
func (x *DownloadArtifactResponse) ProtoReflect() protoreflect.Message
func (*DownloadArtifactResponse) Reset ¶ added in v0.2.0
func (x *DownloadArtifactResponse) Reset()
func (*DownloadArtifactResponse) String ¶ added in v0.2.0
func (x *DownloadArtifactResponse) String() string
type EnvironmentName ¶
type EnvironmentName int32
environment indicates which Workflow Registry to use
const ( EnvironmentName_ENVIRONMENT_NAME_UNSPECIFIED EnvironmentName = 0 // Unspecified environment EnvironmentName_PRODUCTION_MAINNET EnvironmentName = 1 EnvironmentName_PRODUCTION_TESTNET EnvironmentName = 2 )
func (EnvironmentName) Descriptor ¶
func (EnvironmentName) Descriptor() protoreflect.EnumDescriptor
func (EnvironmentName) Enum ¶
func (x EnvironmentName) Enum() *EnvironmentName
func (EnvironmentName) EnumDescriptor
deprecated
func (EnvironmentName) EnumDescriptor() ([]byte, []int)
Deprecated: Use EnvironmentName.Descriptor instead.
func (EnvironmentName) Number ¶
func (x EnvironmentName) Number() protoreflect.EnumNumber
func (EnvironmentName) String ¶
func (x EnvironmentName) String() string
func (EnvironmentName) Type ¶
func (EnvironmentName) Type() protoreflect.EnumType
type NodeServiceClient ¶
type NodeServiceClient interface {
// DownloadArtifact streams a file from the storage service in chunks.
DownloadArtifact(ctx context.Context, in *DownloadArtifactRequest, opts ...grpc.CallOption) (*DownloadArtifactResponse, error)
}
NodeServiceClient is the client API for NodeService 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.
NodeService defines the download-related storage service interface that is used by nodes. Workflow nodes will directly connect via gRPC to the storage service to retrieve presigned URLs which can be used to download workflow artifacts.
func NewNodeServiceClient ¶
func NewNodeServiceClient(cc grpc.ClientConnInterface) NodeServiceClient
type NodeServiceServer ¶
type NodeServiceServer interface {
// DownloadArtifact streams a file from the storage service in chunks.
DownloadArtifact(context.Context, *DownloadArtifactRequest) (*DownloadArtifactResponse, error)
// contains filtered or unexported methods
}
NodeServiceServer is the server API for NodeService service. All implementations must embed UnimplementedNodeServiceServer for forward compatibility.
NodeService defines the download-related storage service interface that is used by nodes. Workflow nodes will directly connect via gRPC to the storage service to retrieve presigned URLs which can be used to download workflow artifacts.
type UnimplementedNodeServiceServer ¶
type UnimplementedNodeServiceServer struct{}
UnimplementedNodeServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedNodeServiceServer) DownloadArtifact ¶
func (UnimplementedNodeServiceServer) DownloadArtifact(context.Context, *DownloadArtifactRequest) (*DownloadArtifactResponse, error)
type UnsafeNodeServiceServer ¶
type UnsafeNodeServiceServer interface {
// contains filtered or unexported methods
}
UnsafeNodeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NodeServiceServer will result in compilation errors.