v1

package
v0.88.9 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package deployment-profile/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 = 0
	// 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 (
	ErrInvalidLengthDeploymentprofile        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowDeploymentprofile          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupDeploymentprofile = fmt.Errorf("proto: unexpected end of group")
)

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

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.

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            *types.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

DeploymentProfile represents a single Deployment Profile for an organization.

func (*DeploymentProfile) Descriptor

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

func (*DeploymentProfile) GetCreatedAt

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

func (*DeploymentProfile) GetDescription

func (m *DeploymentProfile) GetDescription() string

func (*DeploymentProfile) GetId

func (m *DeploymentProfile) GetId() string

func (*DeploymentProfile) GetName

func (m *DeploymentProfile) GetName() string

func (*DeploymentProfile) GetOrganizationId

func (m *DeploymentProfile) GetOrganizationId() string

func (*DeploymentProfile) GetUrl

func (m *DeploymentProfile) GetUrl() string

func (*DeploymentProfile) Marshal

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

func (*DeploymentProfile) MarshalTo

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

func (*DeploymentProfile) MarshalToSizedBuffer

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

func (*DeploymentProfile) ProtoMessage

func (*DeploymentProfile) ProtoMessage()

func (*DeploymentProfile) Reset

func (m *DeploymentProfile) Reset()

func (*DeploymentProfile) Size

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

func (*DeploymentProfile) String

func (m *DeploymentProfile) String() string

func (*DeploymentProfile) Unmarshal

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

func (*DeploymentProfile) XXX_DiscardUnknown

func (m *DeploymentProfile) XXX_DiscardUnknown()

func (*DeploymentProfile) XXX_Marshal

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

func (*DeploymentProfile) XXX_Merge

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

func (*DeploymentProfile) XXX_Size

func (m *DeploymentProfile) XXX_Size() int

func (*DeploymentProfile) XXX_Unmarshal

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

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"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

List of deployment profiles.

func (*DeploymentProfileList) Descriptor

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

func (*DeploymentProfileList) GetItems

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

func (*DeploymentProfileList) Marshal

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

func (*DeploymentProfileList) MarshalTo

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

func (*DeploymentProfileList) MarshalToSizedBuffer

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

func (*DeploymentProfileList) ProtoMessage

func (*DeploymentProfileList) ProtoMessage()

func (*DeploymentProfileList) Reset

func (m *DeploymentProfileList) Reset()

func (*DeploymentProfileList) Size

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

func (*DeploymentProfileList) String

func (m *DeploymentProfileList) String() string

func (*DeploymentProfileList) Unmarshal

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

func (*DeploymentProfileList) XXX_DiscardUnknown

func (m *DeploymentProfileList) XXX_DiscardUnknown()

func (*DeploymentProfileList) XXX_Marshal

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

func (*DeploymentProfileList) XXX_Merge

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

func (*DeploymentProfileList) XXX_Size

func (m *DeploymentProfileList) XXX_Size() int

func (*DeploymentProfileList) XXX_Unmarshal

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

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.ClientConn) 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"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request for listing deployment profiles.

func (*ListDeploymentProfilesRequest) Descriptor

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

func (*ListDeploymentProfilesRequest) GetOptions

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

func (*ListDeploymentProfilesRequest) GetOrganizationId

func (m *ListDeploymentProfilesRequest) GetOrganizationId() string

func (*ListDeploymentProfilesRequest) Marshal

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

func (*ListDeploymentProfilesRequest) MarshalTo

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

func (*ListDeploymentProfilesRequest) MarshalToSizedBuffer

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

func (*ListDeploymentProfilesRequest) ProtoMessage

func (*ListDeploymentProfilesRequest) ProtoMessage()

func (*ListDeploymentProfilesRequest) Reset

func (m *ListDeploymentProfilesRequest) Reset()

func (*ListDeploymentProfilesRequest) Size

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

func (*ListDeploymentProfilesRequest) String

func (*ListDeploymentProfilesRequest) Unmarshal

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

func (*ListDeploymentProfilesRequest) XXX_DiscardUnknown

func (m *ListDeploymentProfilesRequest) XXX_DiscardUnknown()

func (*ListDeploymentProfilesRequest) XXX_Marshal

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

func (*ListDeploymentProfilesRequest) XXX_Merge

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

func (*ListDeploymentProfilesRequest) XXX_Size

func (m *ListDeploymentProfilesRequest) XXX_Size() int

func (*ListDeploymentProfilesRequest) XXX_Unmarshal

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

type UnimplementedDeploymentProfileServiceServer

type UnimplementedDeploymentProfileServiceServer struct {
}

UnimplementedDeploymentProfileServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDeploymentProfileServiceServer) GetAPIVersion

func (*UnimplementedDeploymentProfileServiceServer) ListDeploymentProfiles

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL