v1

package
v0.79.8 Latest Latest
Warning

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

 Go to latest Published: May 15, 2023 License: Apache-2.0 Imports: 21 Imported by: 5

Documentation

Overview

Package example/v1 contains the API of Example services.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// ExampleDatasetIDPayloadLabel is the label used in the event payload for
	// an example dataset.
	ExampleDatasetIDPayloadLabel = "exampledataset_id"
	// DeploymentIDPayloadLabel is the label used in the event payload for
	// the ID of the deployment in which the example is installed.
	DeploymentIDPayloadLabel = "deployment_id"
)
View Source 
const (

	// EventTypeExampleDatasetInstallationCreated is the type of event fired after an installations has been created
	// SubjectID contains the ID of the installation.
	EventTypeExampleDatasetInstallationCreated = "example.exampledatasetinstallation.created"
	// EventTypeExampleDatasetInstallationDeleted is the type of event fired after an installations has been deleted
	// SubjectID contains the ID of the installation.
	EventTypeExampleDatasetInstallationDeleted = "example.exampledatasetinstallation.deleted"
	// EventTypeExampleDatasetInstallationUpdated is the type of event fired after an installations has been updated
	// SubjectID contains the ID of the installation.
	EventTypeExampleDatasetInstallationUpdated = "example.exampledatasetinstallation.updated"
)
View Source 
const (

	// PermissionExampleDatasetInstallationList is needed in order to be able to list example datasets.
	PermissionExampleDatasetInstallationList = "example.exampledatasetinstallation.list"
	// PermissionExampleDatasetInstallationGet is needed to get a single example dataset.
	PermissionExampleDatasetInstallationGet = "example.exampledatasetinstallation.get"
	// PermissionExampleDatasetInstallationCreate is needed to create an example dataset.
	PermissionExampleDatasetInstallationCreate = "example.exampledatasetinstallation.create"
	// PermissionExampleDatasetInstallationDelete is needed to delete an example dataset.
	PermissionExampleDatasetInstallationDelete = "example.exampledatasetinstallation.delete"
	// PermissionExampleDatasetInstallationUpdate is needed to update an example dataset.
	PermissionExampleDatasetInstallationUpdate = "example.exampledatasetinstallation.update"
)
View Source 
const (

	// ExampleInstallationStatusInProgress means that the pod was created successfull and the data is being generated / imported
	ExampleInstallationStatusInProgress = "InProgress"
	// ExampleInstallationStatusCreating means that the database name has been created.
	ExampleInstallationStatusCreating = "Creating"
	// ExampleInstallationStatusCreated means that the database has been successfully created.
	ExampleInstallationStatusCreated = "Created"
	// ExampleInstallationStatusReady means that the data is ready to be used.
	ExampleInstallationStatusReady = "Ready"
	// ExampleInstallationStatusFailed denotes a dataset which has failed to be created.
	ExampleInstallationStatusFailed = "Failed"
	// ExampleInstallationStatusDeleted denotes a dataset of which the database has been deleted.
	ExampleInstallationStatusDeleted = "Deleted"
)
View Source 
const (
	// KindExampleDataset is a constants for the kind of ExampleDataset resources.
	KindExampleDataset = "ExampleDataset"
	// KindExampleDatasetInstallation is a constants for the kind of ExampleDatasetInstallation resources.
	KindExampleDatasetInstallation = "ExampleDatasetInstallation"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "example/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 2
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 1
)

Variables

View Source 
var (
	ErrInvalidLengthExample        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowExample          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupExample = fmt.Errorf("proto: unexpected end of group")
)

Functions

func ExampleDatasetInstallationURL 

func ExampleDatasetInstallationURL(organizationID, projectID, deploymentID, exampleInstallationID string) string

ExampleDatasetInstallationURL creates a resource URL for the ExampleDatasetInstallation with given ID in given context (as individual IDs).

func ExampleDatasetInstallationURL2 

func ExampleDatasetInstallationURL2(deploymentURL, exampleInstallationID string) string

ExampleDatasetInstallationURL2 creates a resource URL for the ExampleDatasetInstallation with given ID in given context (as base URL).

func ExampleDatasetURL 

func ExampleDatasetURL(organizationID, exampleDatasetID string) string

ExampleDatasetURL creates a resource URL for the ExampleDataset with given ID in given context (as individual IDs).

func ExampleDatasetURL2 

func ExampleDatasetURL2(organizationURL, exampleDatasetID string) string

ExampleDatasetURL2 creates a resource URL for the ExampleDataset with given ID in given context (as base URL).

func ForEachExampleDataset 

func ForEachExampleDataset(ctx context.Context, listFunc func(ctx context.Context, req *ListExampleDatasetsRequest) (*ExampleDatasetList, error),
	req ListExampleDatasetsRequest, cb ExampleDatasetCallback) error

ForEachExampleDataset iterates over all example datasets, invoking the given callback for each of them.

func ForEachExampleDatasetInstallation 

func ForEachExampleDatasetInstallation(ctx context.Context, listFunc func(ctx context.Context, req *ListExampleDatasetInstallationsRequest) (*ExampleDatasetInstallationList, error),
	req ListExampleDatasetInstallationsRequest, cb ExampleDatasetInstallationCallback) error

ForEachExampleDatasetInstallation iterates over all example dataset installations for a specific deployment, invoking the given callback for each of them.

func RegisterExampleDatasetServiceHandler 

func RegisterExampleDatasetServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterExampleDatasetServiceHandler registers the http handlers for service ExampleDatasetService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterExampleDatasetServiceHandlerClient 

func RegisterExampleDatasetServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ExampleDatasetServiceClient) error

RegisterExampleDatasetServiceHandlerClient registers the http handlers for service ExampleDatasetService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ExampleDatasetServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ExampleDatasetServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ExampleDatasetServiceClient" to call the correct interceptors.

func RegisterExampleDatasetServiceHandlerFromEndpoint 

func RegisterExampleDatasetServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterExampleDatasetServiceHandlerFromEndpoint is same as RegisterExampleDatasetServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterExampleDatasetServiceHandlerServer 

func RegisterExampleDatasetServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ExampleDatasetServiceServer) error

RegisterExampleDatasetServiceHandlerServer registers the http handlers for service ExampleDatasetService to "mux". UnaryRPC :call ExampleDatasetServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterExampleDatasetServiceServer 

func RegisterExampleDatasetServiceServer(s *grpc.Server, srv ExampleDatasetServiceServer)

Types

type ExampleDataset 

type ExampleDataset struct {
	// System identifier of the example dataset.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource.
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the example dataset
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the example dataset
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Guide contains description of the example dataset including several example queries.
	// Content type of guide is markdown.
	Guide string `protobuf:"bytes,6,opt,name=guide,proto3" json:"guide,omitempty"`
	// The creation timestamp of the example dataset (database object)
	// This is a read-only value.
	CreatedAt            *types.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

ExampleDataset represents a single example dataaset.

func (*ExampleDataset) Clone added in v0.40.8 

func (source *ExampleDataset) Clone() *ExampleDataset

CloneExampleDataset creates a deep copy of the given source

func (*ExampleDataset) Descriptor 

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

func (*ExampleDataset) Equals 

func (source *ExampleDataset) Equals(other *ExampleDataset) bool

Equals returns true when source & other have the same values

func (*ExampleDataset) GetCreatedAt 

func (m *ExampleDataset) GetCreatedAt() *types.Timestamp

func (*ExampleDataset) GetDescription 

func (m *ExampleDataset) GetDescription() string

func (*ExampleDataset) GetGuide 

func (m *ExampleDataset) GetGuide() string

func (*ExampleDataset) GetId 

func (m *ExampleDataset) GetId() string

func (*ExampleDataset) GetName 

func (m *ExampleDataset) GetName() string

func (*ExampleDataset) GetUrl 

func (m *ExampleDataset) GetUrl() string

func (*ExampleDataset) Marshal 

func (m *ExampleDataset) Marshal() (dAtA []byte, err error)

func (*ExampleDataset) MarshalTo 

func (m *ExampleDataset) MarshalTo(dAtA []byte) (int, error)

func (*ExampleDataset) MarshalToSizedBuffer 

func (m *ExampleDataset) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExampleDataset) ProtoMessage 

func (*ExampleDataset) ProtoMessage()

func (*ExampleDataset) Reset 

func (m *ExampleDataset) Reset()

func (*ExampleDataset) Size 

func (m *ExampleDataset) Size() (n int)

func (*ExampleDataset) String 

func (m *ExampleDataset) String() string

func (*ExampleDataset) Unmarshal 

func (m *ExampleDataset) Unmarshal(dAtA []byte) error

func (*ExampleDataset) XXX_DiscardUnknown 

func (m *ExampleDataset) XXX_DiscardUnknown()

func (*ExampleDataset) XXX_Marshal 

func (m *ExampleDataset) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExampleDataset) XXX_Merge 

func (m *ExampleDataset) XXX_Merge(src proto.Message)

func (*ExampleDataset) XXX_Size 

func (m *ExampleDataset) XXX_Size() int

func (*ExampleDataset) XXX_Unmarshal 

func (m *ExampleDataset) XXX_Unmarshal(b []byte) error

type ExampleDatasetCallback 

type ExampleDatasetCallback func(context.Context, *ExampleDataset) error

ExampleDatasetCallback is a callback for individual example datasets.

type ExampleDatasetInstallation 

type ExampleDatasetInstallation struct {
	// System identifier of the installation.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Identifier of the deployment that owns this installation.
	// After creation, this value cannot be changed.
	DeploymentId string `protobuf:"bytes,3,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Identifier of the example dataset which will be installed.
	// After creation, this value cannot be changed.
	ExampledatasetId string `protobuf:"bytes,4,opt,name=exampledataset_id,json=exampledatasetId,proto3" json:"exampledataset_id,omitempty"`
	// The creation timestamp of the installation.
	CreatedAt *types.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The deletion timestamp of the installation
	// This is a read-only value.
	DeletedAt *types.Timestamp `protobuf:"bytes,6,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// Set when this installation is deleted.
	// This is a read-only value.
	IsDeleted bool `protobuf:"varint,7,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// Status of the actual installation.
	Status               *ExampleDatasetInstallation_Status `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                           `json:"-"`
	XXX_unrecognized     []byte                             `json:"-"`
	XXX_sizecache        int32                              `json:"-"`
}

ExampleDatasetInstallation represents an installation of a dataset initiated by the user.

func (*ExampleDatasetInstallation) Clone added in v0.40.8 

func (source *ExampleDatasetInstallation) Clone() *ExampleDatasetInstallation

CloneExampleDatasetInstallation creates a deep copy of the given source

func (*ExampleDatasetInstallation) Descriptor 

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

func (*ExampleDatasetInstallation) Equals 

func (source *ExampleDatasetInstallation) Equals(other *ExampleDatasetInstallation) bool

Equals returns true when source & other have the same values

func (*ExampleDatasetInstallation) GetCreatedAt 

func (m *ExampleDatasetInstallation) GetCreatedAt() *types.Timestamp

func (*ExampleDatasetInstallation) GetDeletedAt added in v0.40.5 

func (m *ExampleDatasetInstallation) GetDeletedAt() *types.Timestamp

func (*ExampleDatasetInstallation) GetDeploymentId 

func (m *ExampleDatasetInstallation) GetDeploymentId() string

func (*ExampleDatasetInstallation) GetExampledatasetId 

func (m *ExampleDatasetInstallation) GetExampledatasetId() string

func (*ExampleDatasetInstallation) GetId 

func (m *ExampleDatasetInstallation) GetId() string

func (*ExampleDatasetInstallation) GetIsDeleted added in v0.40.5 

func (m *ExampleDatasetInstallation) GetIsDeleted() bool

func (*ExampleDatasetInstallation) GetStatus 

func (m *ExampleDatasetInstallation) GetStatus() *ExampleDatasetInstallation_Status

func (*ExampleDatasetInstallation) GetUrl 

func (m *ExampleDatasetInstallation) GetUrl() string

func (*ExampleDatasetInstallation) Marshal 

func (m *ExampleDatasetInstallation) Marshal() (dAtA []byte, err error)

func (*ExampleDatasetInstallation) MarshalTo 

func (m *ExampleDatasetInstallation) MarshalTo(dAtA []byte) (int, error)

func (*ExampleDatasetInstallation) MarshalToSizedBuffer 

func (m *ExampleDatasetInstallation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExampleDatasetInstallation) ProtoMessage 

func (*ExampleDatasetInstallation) ProtoMessage()

func (*ExampleDatasetInstallation) Reset 

func (m *ExampleDatasetInstallation) Reset()

func (*ExampleDatasetInstallation) Size 

func (m *ExampleDatasetInstallation) Size() (n int)

func (*ExampleDatasetInstallation) String 

func (m *ExampleDatasetInstallation) String() string

func (*ExampleDatasetInstallation) Unmarshal 

func (m *ExampleDatasetInstallation) Unmarshal(dAtA []byte) error

func (*ExampleDatasetInstallation) XXX_DiscardUnknown 

func (m *ExampleDatasetInstallation) XXX_DiscardUnknown()

func (*ExampleDatasetInstallation) XXX_Marshal 

func (m *ExampleDatasetInstallation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExampleDatasetInstallation) XXX_Merge 

func (m *ExampleDatasetInstallation) XXX_Merge(src proto.Message)

func (*ExampleDatasetInstallation) XXX_Size 

func (m *ExampleDatasetInstallation) XXX_Size() int

func (*ExampleDatasetInstallation) XXX_Unmarshal 

func (m *ExampleDatasetInstallation) XXX_Unmarshal(b []byte) error

type ExampleDatasetInstallationCallback 

type ExampleDatasetInstallationCallback func(context.Context, *ExampleDatasetInstallation) error

ExampleDatasetInstallationCallback is a callback for individual example dataset installations.

type ExampleDatasetInstallationList 

type ExampleDatasetInstallationList struct {
	Items                []*ExampleDatasetInstallation `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                      `json:"-"`
	XXX_unrecognized     []byte                        `json:"-"`
	XXX_sizecache        int32                         `json:"-"`
}

List of example datasets.

func (*ExampleDatasetInstallationList) Descriptor 

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

func (*ExampleDatasetInstallationList) GetItems 

func (m *ExampleDatasetInstallationList) GetItems() []*ExampleDatasetInstallation

func (*ExampleDatasetInstallationList) Marshal 

func (m *ExampleDatasetInstallationList) Marshal() (dAtA []byte, err error)

func (*ExampleDatasetInstallationList) MarshalTo 

func (m *ExampleDatasetInstallationList) MarshalTo(dAtA []byte) (int, error)

func (*ExampleDatasetInstallationList) MarshalToSizedBuffer 

func (m *ExampleDatasetInstallationList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExampleDatasetInstallationList) ProtoMessage 

func (*ExampleDatasetInstallationList) ProtoMessage()

func (*ExampleDatasetInstallationList) Reset 

func (m *ExampleDatasetInstallationList) Reset()

func (*ExampleDatasetInstallationList) Size 

func (m *ExampleDatasetInstallationList) Size() (n int)

func (*ExampleDatasetInstallationList) String 

func (m *ExampleDatasetInstallationList) String() string

func (*ExampleDatasetInstallationList) Unmarshal 

func (m *ExampleDatasetInstallationList) Unmarshal(dAtA []byte) error

func (*ExampleDatasetInstallationList) XXX_DiscardUnknown 

func (m *ExampleDatasetInstallationList) XXX_DiscardUnknown()

func (*ExampleDatasetInstallationList) XXX_Marshal 

func (m *ExampleDatasetInstallationList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExampleDatasetInstallationList) XXX_Merge 

func (m *ExampleDatasetInstallationList) XXX_Merge(src proto.Message)

func (*ExampleDatasetInstallationList) XXX_Size 

func (m *ExampleDatasetInstallationList) XXX_Size() int

func (*ExampleDatasetInstallationList) XXX_Unmarshal 

func (m *ExampleDatasetInstallationList) XXX_Unmarshal(b []byte) error

type ExampleDatasetInstallation_Status 

type ExampleDatasetInstallation_Status struct {
	// Name of the database into which this example dataset was installed.
	DatabaseName string `protobuf:"bytes,1,opt,name=database_name,json=databaseName,proto3" json:"database_name,omitempty"`
	// The state of the installation.
	// Will be one of the following: "InProgress|Create|Ready|Failed"
	State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	// Set when the installation is failed.
	IsFailed bool `protobuf:"varint,4,opt,name=is_failed,json=isFailed,proto3" json:"is_failed,omitempty"`
	// Set when once the installation finished successfully and the dataset is available to be used.
	IsAvailable bool `protobuf:"varint,5,opt,name=is_available,json=isAvailable,proto3" json:"is_available,omitempty"`
	// Name of ArangoDB user that was created for this installation.
	// Empty when no user is created.
	UserName string `protobuf:"bytes,6,opt,name=user_name,json=userName,proto3" json:"user_name,omitempty"`
	// URL towards demo resulting from this example installation.
	DemoUrl              string   `protobuf:"bytes,7,opt,name=demo_url,json=demoUrl,proto3" json:"demo_url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Status of the installation. All members of this field are read-only.

func (*ExampleDatasetInstallation_Status) Clone added in v0.40.8 

func (source *ExampleDatasetInstallation_Status) Clone() *ExampleDatasetInstallation_Status

CloneExampleDatasetInstallationStatus creates a deep copy fo the given source

func (*ExampleDatasetInstallation_Status) Descriptor 

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

func (*ExampleDatasetInstallation_Status) Equals 

func (source *ExampleDatasetInstallation_Status) Equals(other *ExampleDatasetInstallation_Status) bool

Equals returns true when source & other have the same values

func (*ExampleDatasetInstallation_Status) GetDatabaseName 

func (m *ExampleDatasetInstallation_Status) GetDatabaseName() string

func (*ExampleDatasetInstallation_Status) GetDemoUrl added in v0.74.1 

func (m *ExampleDatasetInstallation_Status) GetDemoUrl() string

func (*ExampleDatasetInstallation_Status) GetIsAvailable 

func (m *ExampleDatasetInstallation_Status) GetIsAvailable() bool

func (*ExampleDatasetInstallation_Status) GetIsFailed 

func (m *ExampleDatasetInstallation_Status) GetIsFailed() bool

func (*ExampleDatasetInstallation_Status) GetState 

func (m *ExampleDatasetInstallation_Status) GetState() string

func (*ExampleDatasetInstallation_Status) GetUserName added in v0.74.1 

func (m *ExampleDatasetInstallation_Status) GetUserName() string

func (*ExampleDatasetInstallation_Status) Marshal 

func (m *ExampleDatasetInstallation_Status) Marshal() (dAtA []byte, err error)

func (*ExampleDatasetInstallation_Status) MarshalTo 

func (m *ExampleDatasetInstallation_Status) MarshalTo(dAtA []byte) (int, error)

func (*ExampleDatasetInstallation_Status) MarshalToSizedBuffer 

func (m *ExampleDatasetInstallation_Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExampleDatasetInstallation_Status) ProtoMessage 

func (*ExampleDatasetInstallation_Status) ProtoMessage()

func (*ExampleDatasetInstallation_Status) Reset 

func (m *ExampleDatasetInstallation_Status) Reset()

func (*ExampleDatasetInstallation_Status) Size 

func (m *ExampleDatasetInstallation_Status) Size() (n int)

func (*ExampleDatasetInstallation_Status) String 

func (m *ExampleDatasetInstallation_Status) String() string

func (*ExampleDatasetInstallation_Status) Unmarshal 

func (m *ExampleDatasetInstallation_Status) Unmarshal(dAtA []byte) error

func (*ExampleDatasetInstallation_Status) XXX_DiscardUnknown 

func (m *ExampleDatasetInstallation_Status) XXX_DiscardUnknown()

func (*ExampleDatasetInstallation_Status) XXX_Marshal 

func (m *ExampleDatasetInstallation_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExampleDatasetInstallation_Status) XXX_Merge 

func (m *ExampleDatasetInstallation_Status) XXX_Merge(src proto.Message)

func (*ExampleDatasetInstallation_Status) XXX_Size 

func (m *ExampleDatasetInstallation_Status) XXX_Size() int

func (*ExampleDatasetInstallation_Status) XXX_Unmarshal 

func (m *ExampleDatasetInstallation_Status) XXX_Unmarshal(b []byte) error

type ExampleDatasetList 

type ExampleDatasetList struct {
	Items                []*ExampleDataset `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

List of example datasets.

func (*ExampleDatasetList) Descriptor 

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

func (*ExampleDatasetList) GetItems 

func (m *ExampleDatasetList) GetItems() []*ExampleDataset

func (*ExampleDatasetList) Marshal 

func (m *ExampleDatasetList) Marshal() (dAtA []byte, err error)

func (*ExampleDatasetList) MarshalTo 

func (m *ExampleDatasetList) MarshalTo(dAtA []byte) (int, error)

func (*ExampleDatasetList) MarshalToSizedBuffer 

func (m *ExampleDatasetList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExampleDatasetList) ProtoMessage 

func (*ExampleDatasetList) ProtoMessage()

func (*ExampleDatasetList) Reset 

func (m *ExampleDatasetList) Reset()

func (*ExampleDatasetList) Size 

func (m *ExampleDatasetList) Size() (n int)

func (*ExampleDatasetList) String 

func (m *ExampleDatasetList) String() string

func (*ExampleDatasetList) Unmarshal 

func (m *ExampleDatasetList) Unmarshal(dAtA []byte) error

func (*ExampleDatasetList) XXX_DiscardUnknown 

func (m *ExampleDatasetList) XXX_DiscardUnknown()

func (*ExampleDatasetList) XXX_Marshal 

func (m *ExampleDatasetList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExampleDatasetList) XXX_Merge 

func (m *ExampleDatasetList) XXX_Merge(src proto.Message)

func (*ExampleDatasetList) XXX_Size 

func (m *ExampleDatasetList) XXX_Size() int

func (*ExampleDatasetList) XXX_Unmarshal 

func (m *ExampleDatasetList) XXX_Unmarshal(b []byte) error

type ExampleDatasetServiceClient 

type ExampleDatasetServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Fetch all example datasets.
	// Required permissions:
	// - None: Caller must be authenticated.
	ListExampleDatasets(ctx context.Context, in *ListExampleDatasetsRequest, opts ...grpc.CallOption) (*ExampleDatasetList, error)
	// Fetch an example dataset identified by the given ID.
	// Required permissions:
	// - None: Caller must be authenticated.
	GetExampleDataset(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*ExampleDataset, error)
	// Fetch all installations for a specific deployment.
	// Required permissions:
	// - example.exampledatasetinstallation.list on the deployment that owns the installation and is identified by the given ID.
	ListExampleDatasetInstallations(ctx context.Context, in *ListExampleDatasetInstallationsRequest, opts ...grpc.CallOption) (*ExampleDatasetInstallationList, error)
	// Fetch an installations identified by the given ID.
	// Required permissions:
	// - example.exampledatasetinstallation.get on the installation identified by the given ID.
	GetExampleDatasetInstallation(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*ExampleDatasetInstallation, error)
	// Create a new example installation. This represents a request made by the user to create an installation
	// for a deployment given a specified example dataset.
	// Required permissions:
	// -  example.exampledatasetinstallation.create on the deployment that the installation is for and is identified by the given ID.
	CreateExampleDatasetInstallation(ctx context.Context, in *ExampleDatasetInstallation, opts ...grpc.CallOption) (*ExampleDatasetInstallation, error)
	// Update an installation.
	// Required permissions:
	// -  example.exampledatasetinstallation.update on the installation identified by the given ID.
	UpdateExampleDatasetInstallation(ctx context.Context, in *ExampleDatasetInstallation, opts ...grpc.CallOption) (*ExampleDatasetInstallation, error)
	// Delete an installation identified by the given ID.
	// Required permissions:
	// -  example.exampledatasetinstallation.delete on the installation identified by the given ID.
	DeleteExampleDatasetInstallation(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
}

ExampleDatasetServiceClient is the client API for ExampleDatasetService service.

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

func NewExampleDatasetServiceClient 

func NewExampleDatasetServiceClient(cc *grpc.ClientConn) ExampleDatasetServiceClient

type ExampleDatasetServiceServer 

type ExampleDatasetServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Fetch all example datasets.
	// Required permissions:
	// - None: Caller must be authenticated.
	ListExampleDatasets(context.Context, *ListExampleDatasetsRequest) (*ExampleDatasetList, error)
	// Fetch an example dataset identified by the given ID.
	// Required permissions:
	// - None: Caller must be authenticated.
	GetExampleDataset(context.Context, *v1.IDOptions) (*ExampleDataset, error)
	// Fetch all installations for a specific deployment.
	// Required permissions:
	// - example.exampledatasetinstallation.list on the deployment that owns the installation and is identified by the given ID.
	ListExampleDatasetInstallations(context.Context, *ListExampleDatasetInstallationsRequest) (*ExampleDatasetInstallationList, error)
	// Fetch an installations identified by the given ID.
	// Required permissions:
	// - example.exampledatasetinstallation.get on the installation identified by the given ID.
	GetExampleDatasetInstallation(context.Context, *v1.IDOptions) (*ExampleDatasetInstallation, error)
	// Create a new example installation. This represents a request made by the user to create an installation
	// for a deployment given a specified example dataset.
	// Required permissions:
	// -  example.exampledatasetinstallation.create on the deployment that the installation is for and is identified by the given ID.
	CreateExampleDatasetInstallation(context.Context, *ExampleDatasetInstallation) (*ExampleDatasetInstallation, error)
	// Update an installation.
	// Required permissions:
	// -  example.exampledatasetinstallation.update on the installation identified by the given ID.
	UpdateExampleDatasetInstallation(context.Context, *ExampleDatasetInstallation) (*ExampleDatasetInstallation, error)
	// Delete an installation identified by the given ID.
	// Required permissions:
	// -  example.exampledatasetinstallation.delete on the installation identified by the given ID.
	DeleteExampleDatasetInstallation(context.Context, *v1.IDOptions) (*v1.Empty, error)
}

ExampleDatasetServiceServer is the server API for ExampleDatasetService service.

type ListExampleDatasetInstallationsRequest 

type ListExampleDatasetInstallationsRequest struct {
	// Identifier of the deployment to request the installations for.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Optional common list options, the context_id is ignored.
	Options              *v1.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request arguments for ListExampleDatasetInstallations.

func (*ListExampleDatasetInstallationsRequest) Descriptor 

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

func (*ListExampleDatasetInstallationsRequest) GetDeploymentId 

func (m *ListExampleDatasetInstallationsRequest) GetDeploymentId() string

func (*ListExampleDatasetInstallationsRequest) GetOptions 

func (m *ListExampleDatasetInstallationsRequest) GetOptions() *v1.ListOptions

func (*ListExampleDatasetInstallationsRequest) Marshal 

func (m *ListExampleDatasetInstallationsRequest) Marshal() (dAtA []byte, err error)

func (*ListExampleDatasetInstallationsRequest) MarshalTo 

func (m *ListExampleDatasetInstallationsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListExampleDatasetInstallationsRequest) MarshalToSizedBuffer 

func (m *ListExampleDatasetInstallationsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListExampleDatasetInstallationsRequest) ProtoMessage 

func (*ListExampleDatasetInstallationsRequest) ProtoMessage()

func (*ListExampleDatasetInstallationsRequest) Reset 

func (m *ListExampleDatasetInstallationsRequest) Reset()

func (*ListExampleDatasetInstallationsRequest) Size 

func (m *ListExampleDatasetInstallationsRequest) Size() (n int)

func (*ListExampleDatasetInstallationsRequest) String 

func (m *ListExampleDatasetInstallationsRequest) String() string

func (*ListExampleDatasetInstallationsRequest) Unmarshal 

func (m *ListExampleDatasetInstallationsRequest) Unmarshal(dAtA []byte) error

func (*ListExampleDatasetInstallationsRequest) XXX_DiscardUnknown 

func (m *ListExampleDatasetInstallationsRequest) XXX_DiscardUnknown()

func (*ListExampleDatasetInstallationsRequest) XXX_Marshal 

func (m *ListExampleDatasetInstallationsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListExampleDatasetInstallationsRequest) XXX_Merge 

func (m *ListExampleDatasetInstallationsRequest) XXX_Merge(src proto.Message)

func (*ListExampleDatasetInstallationsRequest) XXX_Size 

func (m *ListExampleDatasetInstallationsRequest) XXX_Size() int

func (*ListExampleDatasetInstallationsRequest) XXX_Unmarshal 

func (m *ListExampleDatasetInstallationsRequest) XXX_Unmarshal(b []byte) error

type ListExampleDatasetsRequest 

type ListExampleDatasetsRequest struct {
	// Optional common list options, the context_id is ignored.
	Options *v1.ListOptions `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	// If set, the result includes all example datasets which are available for the
	// organization identified by this ID.
	// If not set, only datasets are returned that are available to all organizations.
	OrganizationId       string   `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ListExampleDatasetsRequest provides an extendable list request for listing datasets.

func (*ListExampleDatasetsRequest) Descriptor 

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

func (*ListExampleDatasetsRequest) GetOptions 

func (m *ListExampleDatasetsRequest) GetOptions() *v1.ListOptions

func (*ListExampleDatasetsRequest) GetOrganizationId added in v0.41.1 

func (m *ListExampleDatasetsRequest) GetOrganizationId() string

func (*ListExampleDatasetsRequest) Marshal 

func (m *ListExampleDatasetsRequest) Marshal() (dAtA []byte, err error)

func (*ListExampleDatasetsRequest) MarshalTo 

func (m *ListExampleDatasetsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListExampleDatasetsRequest) MarshalToSizedBuffer 

func (m *ListExampleDatasetsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListExampleDatasetsRequest) ProtoMessage 

func (*ListExampleDatasetsRequest) ProtoMessage()

func (*ListExampleDatasetsRequest) Reset 

func (m *ListExampleDatasetsRequest) Reset()

func (*ListExampleDatasetsRequest) Size 

func (m *ListExampleDatasetsRequest) Size() (n int)

func (*ListExampleDatasetsRequest) String 

func (m *ListExampleDatasetsRequest) String() string

func (*ListExampleDatasetsRequest) Unmarshal 

func (m *ListExampleDatasetsRequest) Unmarshal(dAtA []byte) error

func (*ListExampleDatasetsRequest) XXX_DiscardUnknown 

func (m *ListExampleDatasetsRequest) XXX_DiscardUnknown()

func (*ListExampleDatasetsRequest) XXX_Marshal 

func (m *ListExampleDatasetsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListExampleDatasetsRequest) XXX_Merge 

func (m *ListExampleDatasetsRequest) XXX_Merge(src proto.Message)

func (*ListExampleDatasetsRequest) XXX_Size 

func (m *ListExampleDatasetsRequest) XXX_Size() int

func (*ListExampleDatasetsRequest) XXX_Unmarshal 

func (m *ListExampleDatasetsRequest) XXX_Unmarshal(b []byte) error

type UnimplementedExampleDatasetServiceServer 

type UnimplementedExampleDatasetServiceServer struct {
}

UnimplementedExampleDatasetServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedExampleDatasetServiceServer) CreateExampleDatasetInstallation 

func (*UnimplementedExampleDatasetServiceServer) CreateExampleDatasetInstallation(ctx context.Context, req *ExampleDatasetInstallation) (*ExampleDatasetInstallation, error)

func (*UnimplementedExampleDatasetServiceServer) DeleteExampleDatasetInstallation 

func (*UnimplementedExampleDatasetServiceServer) DeleteExampleDatasetInstallation(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedExampleDatasetServiceServer) GetAPIVersion 

func (*UnimplementedExampleDatasetServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)

func (*UnimplementedExampleDatasetServiceServer) GetExampleDataset 

func (*UnimplementedExampleDatasetServiceServer) GetExampleDataset(ctx context.Context, req *v1.IDOptions) (*ExampleDataset, error)

func (*UnimplementedExampleDatasetServiceServer) GetExampleDatasetInstallation 

func (*UnimplementedExampleDatasetServiceServer) GetExampleDatasetInstallation(ctx context.Context, req *v1.IDOptions) (*ExampleDatasetInstallation, error)

func (*UnimplementedExampleDatasetServiceServer) ListExampleDatasetInstallations 

func (*UnimplementedExampleDatasetServiceServer) ListExampleDatasetInstallations(ctx context.Context, req *ListExampleDatasetInstallationsRequest) (*ExampleDatasetInstallationList, error)

func (*UnimplementedExampleDatasetServiceServer) ListExampleDatasets 

func (*UnimplementedExampleDatasetServiceServer) ListExampleDatasets(ctx context.Context, req *ListExampleDatasetsRequest) (*ExampleDatasetList, error)

func (*UnimplementedExampleDatasetServiceServer) UpdateExampleDatasetInstallation 

func (*UnimplementedExampleDatasetServiceServer) UpdateExampleDatasetInstallation(ctx context.Context, req *ExampleDatasetInstallation) (*ExampleDatasetInstallation, error)

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.