v1

Documentation

Overview

Package v1 contains the integration API of Data service.

Index

• Constants
• Variables
• func RegisterDataServiceServer(s *grpc.Server, srv DataServiceServer)
• type DataServiceClient
  • func NewDataServiceClient(cc grpc.ClientConnInterface) DataServiceClient
• type DataServiceServer
• type UnimplementedDataServiceServer
  • func (*UnimplementedDataServiceServer) GetDeploymentRootCredentials(context.Context, *v1.IDOptions) (*v11.DeploymentCredentials, error)

Constants

const (
	// APIIDDataService contains identifier of this API
	APIIDDataService = "dataservice/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 1
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 1
)

const (

	// PermissionDataServiceGetDeploymentRootCredentials is needed for getting the root credentials of a deployment.
	PermissionDataServiceGetDeploymentRootCredentials = "dataservice.deployment.get-root-credentials"
)

Variables

var File_dataservice_proto protoreflect.FileDescriptor

Functions

func RegisterDataServiceServer

func RegisterDataServiceServer(s *grpc.Server, srv DataServiceServer)

Types

type DataServiceClient

type DataServiceClient interface {
	// Fetch the credentials for the root user of the deployment with given ID.
	// When the integration sidecar is running in the context of a single deployment, the provided ID is optional, however if provided it should match.
	// Required permissions:
	// - dataservice.deployment.get-root-credentials for the deployment.
	GetDeploymentRootCredentials(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v11.DeploymentCredentials, error)
}

DataServiceClient is the client API for DataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDataServiceClient

func NewDataServiceClient(cc grpc.ClientConnInterface) DataServiceClient

type DataServiceServer

type DataServiceServer interface {
	// Fetch the credentials for the root user of the deployment with given ID.
	// When the integration sidecar is running in the context of a single deployment, the provided ID is optional, however if provided it should match.
	// Required permissions:
	// - dataservice.deployment.get-root-credentials for the deployment.
	GetDeploymentRootCredentials(context.Context, *v1.IDOptions) (*v11.DeploymentCredentials, error)
}

DataServiceServer is the server API for DataService service.

type UnimplementedDataServiceServer

type UnimplementedDataServiceServer struct {
}

UnimplementedDataServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataServiceServer) GetDeploymentRootCredentials

func (*UnimplementedDataServiceServer) GetDeploymentRootCredentials(context.Context, *v1.IDOptions) (*v11.DeploymentCredentials, error)