v1

package
v0.89.1 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package v1 contains the API of Deployment Profile service.

Index

Constants

View Source 
const (

	// EventTypeDeploymentProfileCreated is the type of event fired after a Deployment Profile has been created.
	// SubjectID contains the ID of the Deployment Profile.
	EventTypeDeploymentProfileCreated = "deploymentprofile.deploymentprofile.created"
	// EventTypeDeploymentProfileUpdated is the type of event fired after a Deployment Profile has been updated.
	// SubjectID contains the ID of the Deployment Profile.
	EventTypeDeploymentProfileUpdated = "deploymentprofile.deploymentprofile.updated"
	// EventTypeDeploymentProfileDeleted is the type of event fired after a Deployment Profile has been deleted.
	// SubjectID contains the ID of the Deployment Profile.
	EventTypeDeploymentProfileDeleted = "deploymentprofile.deploymentprofile.deleted"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "deploymentprofile/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 = 0
)
View Source 
const (
	// KindDeploymentProfile is a constant for the kind of DeploymentProfile resources.
	KindDeploymentProfile = "DeploymentProfile"
)
View Source 
const (

	// PermissionDeploymentProfileList is needed for listing Deployment Profiles in an organization
	PermissionDeploymentProfileList = "deploymentprofile.deploymentprofile.list"
)

Variables

View Source 
var File_deploymentprofile_proto protoreflect.FileDescriptor

Functions

func DeploymentProfileURL 

func DeploymentProfileURL(organizationID, deploymentProfileID string) string

DeploymentProfileURL creates a resource URL for the DeploymentProfile with given ID in given context.

func ForEachDeploymentProfile 

func ForEachDeploymentProfile(ctx context.Context, listFunc func(ctx context.Context, req *ListDeploymentProfilesRequest) (*DeploymentProfileList, error),
	opts *ListDeploymentProfilesRequest, cb DeploymentProfileCallback) error

ForEachDeploymentProfile iterates over all deployment profiles in the organization identified by the given context ID, invoking the given callback for each deployment profile.

func RegisterDeploymentProfileServiceHandler 

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

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

func RegisterDeploymentProfileServiceHandlerClient 

func RegisterDeploymentProfileServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DeploymentProfileServiceClient) error

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

func RegisterDeploymentProfileServiceHandlerFromEndpoint 

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

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

func RegisterDeploymentProfileServiceHandlerServer 

func RegisterDeploymentProfileServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DeploymentProfileServiceServer) error

RegisterDeploymentProfileServiceHandlerServer registers the http handlers for service DeploymentProfileService to "mux". UnaryRPC :call DeploymentProfileServiceServer 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 RegisterDeploymentProfileServiceHandlerFromEndpoint instead.

func RegisterDeploymentProfileServiceServer 

func RegisterDeploymentProfileServiceServer(s *grpc.Server, srv DeploymentProfileServiceServer)

Types

type DeploymentProfile 

type DeploymentProfile struct {

	// System identifier of the deployment profile.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of the deployment profile resource.
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the deployment profile.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the deployment profile.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Organization id of the deployment profile.
	// This is a read-only value.
	OrganizationId string `protobuf:"bytes,5,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// The creation timestamp of the deployment profile.
	// This is a read-only value.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// contains filtered or unexported fields
}

DeploymentProfile represents a single Deployment Profile for an organization.

func (*DeploymentProfile) Descriptor deprecated 

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

Deprecated: Use DeploymentProfile.ProtoReflect.Descriptor instead.

func (*DeploymentProfile) GetCreatedAt 

func (x *DeploymentProfile) GetCreatedAt() *timestamppb.Timestamp

func (*DeploymentProfile) GetDescription 

func (x *DeploymentProfile) GetDescription() string

func (*DeploymentProfile) GetId 

func (x *DeploymentProfile) GetId() string

func (*DeploymentProfile) GetName 

func (x *DeploymentProfile) GetName() string

func (*DeploymentProfile) GetOrganizationId 

func (x *DeploymentProfile) GetOrganizationId() string

func (*DeploymentProfile) GetUrl 

func (x *DeploymentProfile) GetUrl() string

func (*DeploymentProfile) ProtoMessage 

func (*DeploymentProfile) ProtoMessage()

func (*DeploymentProfile) ProtoReflect added in v0.89.0 

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

func (*DeploymentProfile) Reset 

func (x *DeploymentProfile) Reset()

func (*DeploymentProfile) String 

func (x *DeploymentProfile) String() string

type DeploymentProfileCallback 

type DeploymentProfileCallback func(context.Context, *DeploymentProfile) error

DeploymentProfileCallback is a callback for individual deployment profiles.

type DeploymentProfileList 

type DeploymentProfileList struct {
	Items []*DeploymentProfile `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of deployment profiles.

func (*DeploymentProfileList) Descriptor deprecated 

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

Deprecated: Use DeploymentProfileList.ProtoReflect.Descriptor instead.

func (*DeploymentProfileList) GetItems 

func (x *DeploymentProfileList) GetItems() []*DeploymentProfile

func (*DeploymentProfileList) ProtoMessage 

func (*DeploymentProfileList) ProtoMessage()

func (*DeploymentProfileList) ProtoReflect added in v0.89.0 

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

func (*DeploymentProfileList) Reset 

func (x *DeploymentProfileList) Reset()

func (*DeploymentProfileList) String 

func (x *DeploymentProfileList) String() string

type DeploymentProfileServiceClient 

type DeploymentProfileServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// List all deployment profiles for the organization identified by the given organization identifier.
	// Required permissions:
	// - deploymentprofile.deploymentprofile.list on the organization
	ListDeploymentProfiles(ctx context.Context, in *ListDeploymentProfilesRequest, opts ...grpc.CallOption) (*DeploymentProfileList, error)
}

DeploymentProfileServiceClient is the client API for DeploymentProfileService service.

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

func NewDeploymentProfileServiceClient 

func NewDeploymentProfileServiceClient(cc grpc.ClientConnInterface) DeploymentProfileServiceClient

type DeploymentProfileServiceServer 

type DeploymentProfileServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// List all deployment profiles for the organization identified by the given organization identifier.
	// Required permissions:
	// - deploymentprofile.deploymentprofile.list on the organization
	ListDeploymentProfiles(context.Context, *ListDeploymentProfilesRequest) (*DeploymentProfileList, error)
}

DeploymentProfileServiceServer is the server API for DeploymentProfileService service.

type ListDeploymentProfilesRequest 

type ListDeploymentProfilesRequest struct {

	// List deployment profiles for this organization ID.
	// This is a required field.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Optional common list options, the context_id is ignored
	// This is an optional field.
	Options *v1.ListOptions `protobuf:"bytes,3,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

Request for listing deployment profiles.

func (*ListDeploymentProfilesRequest) Descriptor deprecated 

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

Deprecated: Use ListDeploymentProfilesRequest.ProtoReflect.Descriptor instead.

func (*ListDeploymentProfilesRequest) GetOptions 

func (x *ListDeploymentProfilesRequest) GetOptions() *v1.ListOptions

func (*ListDeploymentProfilesRequest) GetOrganizationId 

func (x *ListDeploymentProfilesRequest) GetOrganizationId() string

func (*ListDeploymentProfilesRequest) ProtoMessage 

func (*ListDeploymentProfilesRequest) ProtoMessage()

func (*ListDeploymentProfilesRequest) ProtoReflect added in v0.89.0 

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

func (*ListDeploymentProfilesRequest) Reset 

func (x *ListDeploymentProfilesRequest) Reset()

func (*ListDeploymentProfilesRequest) String 

func (x *ListDeploymentProfilesRequest) String() string

type UnimplementedDeploymentProfileServiceServer 

type UnimplementedDeploymentProfileServiceServer struct {
}

UnimplementedDeploymentProfileServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDeploymentProfileServiceServer) GetAPIVersion 

func (*UnimplementedDeploymentProfileServiceServer) GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)

func (*UnimplementedDeploymentProfileServiceServer) ListDeploymentProfiles 

func (*UnimplementedDeploymentProfileServiceServer) ListDeploymentProfiles(context.Context, *ListDeploymentProfilesRequest) (*DeploymentProfileList, 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.