annotationv1

package
v0.0.0-...-94cd6a6 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	AnnotationService_AddAnnotation_FullMethodName              = "/cloudstack.management.annotation.v1.AnnotationService/AddAnnotation"
	AnnotationService_ListAnnotations_FullMethodName            = "/cloudstack.management.annotation.v1.AnnotationService/ListAnnotations"
	AnnotationService_RemoveAnnotation_FullMethodName           = "/cloudstack.management.annotation.v1.AnnotationService/RemoveAnnotation"
	AnnotationService_UpdateAnnotationVisibility_FullMethodName = "/cloudstack.management.annotation.v1.AnnotationService/UpdateAnnotationVisibility"
)

Variables

View Source
var AnnotationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cloudstack.management.annotation.v1.AnnotationService",
	HandlerType: (*AnnotationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AddAnnotation",
			Handler:    _AnnotationService_AddAnnotation_Handler,
		},
		{
			MethodName: "ListAnnotations",
			Handler:    _AnnotationService_ListAnnotations_Handler,
		},
		{
			MethodName: "RemoveAnnotation",
			Handler:    _AnnotationService_RemoveAnnotation_Handler,
		},
		{
			MethodName: "UpdateAnnotationVisibility",
			Handler:    _AnnotationService_UpdateAnnotationVisibility_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cloudstack/management/annotation/v1/annotation.gen.proto",
}

AnnotationService_ServiceDesc is the grpc.ServiceDesc for AnnotationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_cloudstack_management_annotation_v1_annotation_gen_proto protoreflect.FileDescriptor

Functions

func RegisterAnnotationServiceServer

func RegisterAnnotationServiceServer(s grpc.ServiceRegistrar, srv AnnotationServiceServer)

Types

type AddAnnotationRequest

type AddAnnotationRequest struct {

	// the annotation text
	Annotation *string `protobuf:"bytes,1,opt,name=annotation" json:"annotation,omitempty"`
	// The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER
	EntityType *string `protobuf:"bytes,2,opt,name=entity_type,json=entityType" json:"entity_type,omitempty"`
	// the id of the entity to annotate
	EntityUuid *string `protobuf:"bytes,3,opt,name=entity_uuid,json=entityUuid" json:"entity_uuid,omitempty"`
	// the annotation is visible for admins only
	AdminsOnly   *bool   `protobuf:"varint,4,opt,name=admins_only,json=adminsOnly" json:"admins_only,omitempty"`
	ResponseType *string `protobuf:"bytes,5,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

AddAnnotationRequest represents the parameters for add an annotation.

func (*AddAnnotationRequest) Descriptor deprecated

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

Deprecated: Use AddAnnotationRequest.ProtoReflect.Descriptor instead.

func (*AddAnnotationRequest) GetAdminsOnly

func (x *AddAnnotationRequest) GetAdminsOnly() bool

func (*AddAnnotationRequest) GetAnnotation

func (x *AddAnnotationRequest) GetAnnotation() string

func (*AddAnnotationRequest) GetEntityType

func (x *AddAnnotationRequest) GetEntityType() string

func (*AddAnnotationRequest) GetEntityUuid

func (x *AddAnnotationRequest) GetEntityUuid() string

func (*AddAnnotationRequest) GetResponseType

func (x *AddAnnotationRequest) GetResponseType() string

func (*AddAnnotationRequest) ProtoMessage

func (*AddAnnotationRequest) ProtoMessage()

func (*AddAnnotationRequest) ProtoReflect

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

func (*AddAnnotationRequest) Reset

func (x *AddAnnotationRequest) Reset()

func (*AddAnnotationRequest) String

func (x *AddAnnotationRequest) String() string

type AddAnnotationResponse

type AddAnnotationResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

AddAnnotationResponse represents the response from add an annotation.

func (*AddAnnotationResponse) Descriptor deprecated

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

Deprecated: Use AddAnnotationResponse.ProtoReflect.Descriptor instead.

func (*AddAnnotationResponse) GetResult

func (x *AddAnnotationResponse) GetResult() *Result

func (*AddAnnotationResponse) ProtoMessage

func (*AddAnnotationResponse) ProtoMessage()

func (*AddAnnotationResponse) ProtoReflect

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

func (*AddAnnotationResponse) Reset

func (x *AddAnnotationResponse) Reset()

func (*AddAnnotationResponse) String

func (x *AddAnnotationResponse) String() string

type Annotation

type Annotation struct {

	// The ID of the Annotation
	Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The name of the Annotation
	Name *string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The display name of the Annotation
	DisplayName *string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// The description of the Annotation
	Description *string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// The date this entity was created
	Created *string `protobuf:"bytes,5,opt,name=created" json:"created,omitempty"`
	// contains filtered or unexported fields
}

Annotation represents a Annotation Item

func (*Annotation) Descriptor deprecated

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

Deprecated: Use Annotation.ProtoReflect.Descriptor instead.

func (*Annotation) GetCreated

func (x *Annotation) GetCreated() string

func (*Annotation) GetDescription

func (x *Annotation) GetDescription() string

func (*Annotation) GetDisplayName

func (x *Annotation) GetDisplayName() string

func (*Annotation) GetId

func (x *Annotation) GetId() string

func (*Annotation) GetName

func (x *Annotation) GetName() string

func (*Annotation) ProtoMessage

func (*Annotation) ProtoMessage()

func (*Annotation) ProtoReflect

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

func (*Annotation) Reset

func (x *Annotation) Reset()

func (*Annotation) String

func (x *Annotation) String() string

type AnnotationServiceClient

type AnnotationServiceClient interface {
	// AddAnnotation add an annotation.
	AddAnnotation(ctx context.Context, in *AddAnnotationRequest, opts ...grpc.CallOption) (*AddAnnotationResponse, error)
	// ListAnnotations Lists annotations.
	ListAnnotations(ctx context.Context, in *ListAnnotationsRequest, opts ...grpc.CallOption) (*ListAnnotationsResponse, error)
	// RemoveAnnotation remove an annotation.
	RemoveAnnotation(ctx context.Context, in *RemoveAnnotationRequest, opts ...grpc.CallOption) (*RemoveAnnotationResponse, error)
	// UpdateAnnotationVisibility update an annotation visibility.
	UpdateAnnotationVisibility(ctx context.Context, in *UpdateAnnotationVisibilityRequest, opts ...grpc.CallOption) (*UpdateAnnotationVisibilityResponse, error)
}

AnnotationServiceClient is the client API for AnnotationService 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.

AnnotationService provides operations for managing Annotations

type AnnotationServiceServer

type AnnotationServiceServer interface {
	// AddAnnotation add an annotation.
	AddAnnotation(context.Context, *AddAnnotationRequest) (*AddAnnotationResponse, error)
	// ListAnnotations Lists annotations.
	ListAnnotations(context.Context, *ListAnnotationsRequest) (*ListAnnotationsResponse, error)
	// RemoveAnnotation remove an annotation.
	RemoveAnnotation(context.Context, *RemoveAnnotationRequest) (*RemoveAnnotationResponse, error)
	// UpdateAnnotationVisibility update an annotation visibility.
	UpdateAnnotationVisibility(context.Context, *UpdateAnnotationVisibilityRequest) (*UpdateAnnotationVisibilityResponse, error)
	// contains filtered or unexported methods
}

AnnotationServiceServer is the server API for AnnotationService service. All implementations must embed UnimplementedAnnotationServiceServer for forward compatibility.

AnnotationService provides operations for managing Annotations

type ListAnnotationsRequest

type ListAnnotationsRequest struct {

	// the id of the annotation
	Uuid *string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// the entity type
	EntityType *string `protobuf:"bytes,2,opt,name=entity_type,json=entityType" json:"entity_type,omitempty"`
	// the id of the entity for which to show annotations
	EntityUuid *string `protobuf:"bytes,3,opt,name=entity_uuid,json=entityUuid" json:"entity_uuid,omitempty"`
	// optional: the id of the user of the annotation
	UserUuid *string `protobuf:"bytes,4,opt,name=user_uuid,json=userUuid" json:"user_uuid,omitempty"`
	// possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access
	AnnotationFilter *string `protobuf:"bytes,5,opt,name=annotation_filter,json=annotationFilter" json:"annotation_filter,omitempty"`
	// List by keyword
	Keyword      *string `protobuf:"bytes,6,opt,name=keyword" json:"keyword,omitempty"`
	Page         *int32  `protobuf:"varint,7,opt,name=page" json:"page,omitempty"`
	PageSize     *int32  `protobuf:"varint,8,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	ResponseType *string `protobuf:"bytes,9,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

ListAnnotationsRequest represents the parameters for lists annotations.

func (*ListAnnotationsRequest) Descriptor deprecated

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

Deprecated: Use ListAnnotationsRequest.ProtoReflect.Descriptor instead.

func (*ListAnnotationsRequest) GetAnnotationFilter

func (x *ListAnnotationsRequest) GetAnnotationFilter() string

func (*ListAnnotationsRequest) GetEntityType

func (x *ListAnnotationsRequest) GetEntityType() string

func (*ListAnnotationsRequest) GetEntityUuid

func (x *ListAnnotationsRequest) GetEntityUuid() string

func (*ListAnnotationsRequest) GetKeyword

func (x *ListAnnotationsRequest) GetKeyword() string

func (*ListAnnotationsRequest) GetPage

func (x *ListAnnotationsRequest) GetPage() int32

func (*ListAnnotationsRequest) GetPageSize

func (x *ListAnnotationsRequest) GetPageSize() int32

func (*ListAnnotationsRequest) GetResponseType

func (x *ListAnnotationsRequest) GetResponseType() string

func (*ListAnnotationsRequest) GetUserUuid

func (x *ListAnnotationsRequest) GetUserUuid() string

func (*ListAnnotationsRequest) GetUuid

func (x *ListAnnotationsRequest) GetUuid() string

func (*ListAnnotationsRequest) ProtoMessage

func (*ListAnnotationsRequest) ProtoMessage()

func (*ListAnnotationsRequest) ProtoReflect

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

func (*ListAnnotationsRequest) Reset

func (x *ListAnnotationsRequest) Reset()

func (*ListAnnotationsRequest) String

func (x *ListAnnotationsRequest) String() string

type ListAnnotationsResponse

type ListAnnotationsResponse struct {

	// The list of Annotations
	Items []*Annotation `protobuf:"bytes,1,rep,name=items" json:"items,omitempty"`
	// The total count of Annotations
	TotalCount *int32 `protobuf:"varint,2,opt,name=total_count,json=totalCount" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

ListAnnotationsResponse represents the response from lists annotations.

func (*ListAnnotationsResponse) Descriptor deprecated

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

Deprecated: Use ListAnnotationsResponse.ProtoReflect.Descriptor instead.

func (*ListAnnotationsResponse) GetItems

func (x *ListAnnotationsResponse) GetItems() []*Annotation

func (*ListAnnotationsResponse) GetTotalCount

func (x *ListAnnotationsResponse) GetTotalCount() int32

func (*ListAnnotationsResponse) ProtoMessage

func (*ListAnnotationsResponse) ProtoMessage()

func (*ListAnnotationsResponse) ProtoReflect

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

func (*ListAnnotationsResponse) Reset

func (x *ListAnnotationsResponse) Reset()

func (*ListAnnotationsResponse) String

func (x *ListAnnotationsResponse) String() string

type RemoveAnnotationRequest

type RemoveAnnotationRequest struct {

	// the id of the annotation
	Uuid         *string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

RemoveAnnotationRequest represents the parameters for remove an annotation.

func (*RemoveAnnotationRequest) Descriptor deprecated

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

Deprecated: Use RemoveAnnotationRequest.ProtoReflect.Descriptor instead.

func (*RemoveAnnotationRequest) GetResponseType

func (x *RemoveAnnotationRequest) GetResponseType() string

func (*RemoveAnnotationRequest) GetUuid

func (x *RemoveAnnotationRequest) GetUuid() string

func (*RemoveAnnotationRequest) ProtoMessage

func (*RemoveAnnotationRequest) ProtoMessage()

func (*RemoveAnnotationRequest) ProtoReflect

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

func (*RemoveAnnotationRequest) Reset

func (x *RemoveAnnotationRequest) Reset()

func (*RemoveAnnotationRequest) String

func (x *RemoveAnnotationRequest) String() string

type RemoveAnnotationResponse

type RemoveAnnotationResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

RemoveAnnotationResponse represents the response from remove an annotation.

func (*RemoveAnnotationResponse) Descriptor deprecated

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

Deprecated: Use RemoveAnnotationResponse.ProtoReflect.Descriptor instead.

func (*RemoveAnnotationResponse) GetResult

func (x *RemoveAnnotationResponse) GetResult() *Result

func (*RemoveAnnotationResponse) ProtoMessage

func (*RemoveAnnotationResponse) ProtoMessage()

func (*RemoveAnnotationResponse) ProtoReflect

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

func (*RemoveAnnotationResponse) Reset

func (x *RemoveAnnotationResponse) Reset()

func (*RemoveAnnotationResponse) String

func (x *RemoveAnnotationResponse) String() string

type Result

type Result struct {

	// Whether the operation was successful
	Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	// Any text associated with the success or failure
	DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"`
	// The ID of the resource affected by the operation
	Id *string `protobuf:"bytes,3,opt,name=id" json:"id,omitempty"`
	// The job ID for an async operation
	JobId *string `protobuf:"bytes,4,opt,name=job_id,json=jobId" json:"job_id,omitempty"`
	// The status of the job
	JobStatus *string `protobuf:"bytes,5,opt,name=job_status,json=jobStatus" json:"job_status,omitempty"`
	// contains filtered or unexported fields
}

Result represents a generic operation result

func (*Result) Descriptor deprecated

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

Deprecated: Use Result.ProtoReflect.Descriptor instead.

func (*Result) GetDisplayText

func (x *Result) GetDisplayText() string

func (*Result) GetId

func (x *Result) GetId() string

func (*Result) GetJobId

func (x *Result) GetJobId() string

func (*Result) GetJobStatus

func (x *Result) GetJobStatus() string

func (*Result) GetSuccess

func (x *Result) GetSuccess() bool

func (*Result) ProtoMessage

func (*Result) ProtoMessage()

func (*Result) ProtoReflect

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

func (*Result) Reset

func (x *Result) Reset()

func (*Result) String

func (x *Result) String() string

type Success

type Success struct {

	// true if operation is executed successfully
	Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	// any text associated with the success or failure
	DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"`
	// contains filtered or unexported fields
}

Success represents a Success Operation Response

func (*Success) Descriptor deprecated

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

Deprecated: Use Success.ProtoReflect.Descriptor instead.

func (*Success) GetDisplayText

func (x *Success) GetDisplayText() string

func (*Success) GetSuccess

func (x *Success) GetSuccess() bool

func (*Success) ProtoMessage

func (*Success) ProtoMessage()

func (*Success) ProtoReflect

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

func (*Success) Reset

func (x *Success) Reset()

func (*Success) String

func (x *Success) String() string

type UnimplementedAnnotationServiceServer

type UnimplementedAnnotationServiceServer struct{}

UnimplementedAnnotationServiceServer 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 (UnimplementedAnnotationServiceServer) AddAnnotation

func (UnimplementedAnnotationServiceServer) ListAnnotations

func (UnimplementedAnnotationServiceServer) RemoveAnnotation

type UnsafeAnnotationServiceServer

type UnsafeAnnotationServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAnnotationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AnnotationServiceServer will result in compilation errors.

type UpdateAnnotationVisibilityRequest

type UpdateAnnotationVisibilityRequest struct {

	// the id of the annotation
	Uuid *string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// the annotation is visible for admins only
	AdminsOnly   *bool   `protobuf:"varint,2,opt,name=admins_only,json=adminsOnly" json:"admins_only,omitempty"`
	ResponseType *string `protobuf:"bytes,3,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

UpdateAnnotationVisibilityRequest represents the parameters for update an annotation visibility.

func (*UpdateAnnotationVisibilityRequest) Descriptor deprecated

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

Deprecated: Use UpdateAnnotationVisibilityRequest.ProtoReflect.Descriptor instead.

func (*UpdateAnnotationVisibilityRequest) GetAdminsOnly

func (x *UpdateAnnotationVisibilityRequest) GetAdminsOnly() bool

func (*UpdateAnnotationVisibilityRequest) GetResponseType

func (x *UpdateAnnotationVisibilityRequest) GetResponseType() string

func (*UpdateAnnotationVisibilityRequest) GetUuid

func (*UpdateAnnotationVisibilityRequest) ProtoMessage

func (*UpdateAnnotationVisibilityRequest) ProtoMessage()

func (*UpdateAnnotationVisibilityRequest) ProtoReflect

func (*UpdateAnnotationVisibilityRequest) Reset

func (*UpdateAnnotationVisibilityRequest) String

type UpdateAnnotationVisibilityResponse

type UpdateAnnotationVisibilityResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

UpdateAnnotationVisibilityResponse represents the response from update an annotation visibility.

func (*UpdateAnnotationVisibilityResponse) Descriptor deprecated

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

Deprecated: Use UpdateAnnotationVisibilityResponse.ProtoReflect.Descriptor instead.

func (*UpdateAnnotationVisibilityResponse) GetResult

func (*UpdateAnnotationVisibilityResponse) ProtoMessage

func (*UpdateAnnotationVisibilityResponse) ProtoMessage()

func (*UpdateAnnotationVisibilityResponse) ProtoReflect

func (*UpdateAnnotationVisibilityResponse) Reset

func (*UpdateAnnotationVisibilityResponse) String

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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