userdatav1

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 (
	UserdataService_DeleteUserData_FullMethodName         = "/cloudstack.management.userdata.v1.UserdataService/DeleteUserData"
	UserdataService_LinkUserDataToTemplate_FullMethodName = "/cloudstack.management.userdata.v1.UserdataService/LinkUserDataToTemplate"
	UserdataService_ListUserData_FullMethodName           = "/cloudstack.management.userdata.v1.UserdataService/ListUserData"
	UserdataService_RegisterUserData_FullMethodName       = "/cloudstack.management.userdata.v1.UserdataService/RegisterUserData"
)

Variables

View Source
var File_cloudstack_management_userdata_v1_userdata_gen_proto protoreflect.FileDescriptor
View Source
var UserdataService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cloudstack.management.userdata.v1.UserdataService",
	HandlerType: (*UserdataServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "DeleteUserData",
			Handler:    _UserdataService_DeleteUserData_Handler,
		},
		{
			MethodName: "LinkUserDataToTemplate",
			Handler:    _UserdataService_LinkUserDataToTemplate_Handler,
		},
		{
			MethodName: "ListUserData",
			Handler:    _UserdataService_ListUserData_Handler,
		},
		{
			MethodName: "RegisterUserData",
			Handler:    _UserdataService_RegisterUserData_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cloudstack/management/userdata/v1/userdata.gen.proto",
}

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

Functions

func RegisterUserdataServiceServer

func RegisterUserdataServiceServer(s grpc.ServiceRegistrar, srv UserdataServiceServer)

Types

type DeleteUserDataRequest

type DeleteUserDataRequest struct {

	// the ID of the Userdata
	Id *int64 `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	// an optional account for the userdata. Must be used with domainId.
	AccountName *string `protobuf:"bytes,2,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// an optional domainId for the userdata. If the account parameter is used, domainId must also be used.
	DomainId *int64 `protobuf:"varint,3,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	// an optional project for the userdata
	ProjectId    *int64  `protobuf:"varint,4,opt,name=project_id,json=projectId" json:"project_id,omitempty"`
	ResponseType *string `protobuf:"bytes,5,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

DeleteUserDataRequest represents the parameters for deletes a userdata

func (*DeleteUserDataRequest) Descriptor deprecated

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

Deprecated: Use DeleteUserDataRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserDataRequest) GetAccountName

func (x *DeleteUserDataRequest) GetAccountName() string

func (*DeleteUserDataRequest) GetDomainId

func (x *DeleteUserDataRequest) GetDomainId() int64

func (*DeleteUserDataRequest) GetId

func (x *DeleteUserDataRequest) GetId() int64

func (*DeleteUserDataRequest) GetProjectId

func (x *DeleteUserDataRequest) GetProjectId() int64

func (*DeleteUserDataRequest) GetResponseType

func (x *DeleteUserDataRequest) GetResponseType() string

func (*DeleteUserDataRequest) ProtoMessage

func (*DeleteUserDataRequest) ProtoMessage()

func (*DeleteUserDataRequest) ProtoReflect

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

func (*DeleteUserDataRequest) Reset

func (x *DeleteUserDataRequest) Reset()

func (*DeleteUserDataRequest) String

func (x *DeleteUserDataRequest) String() string

type DeleteUserDataResponse

type DeleteUserDataResponse struct {

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

DeleteUserDataResponse represents the response from deletes a userdata

func (*DeleteUserDataResponse) Descriptor deprecated

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

Deprecated: Use DeleteUserDataResponse.ProtoReflect.Descriptor instead.

func (*DeleteUserDataResponse) GetResult

func (x *DeleteUserDataResponse) GetResult() *Result

func (*DeleteUserDataResponse) ProtoMessage

func (*DeleteUserDataResponse) ProtoMessage()

func (*DeleteUserDataResponse) ProtoReflect

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

func (*DeleteUserDataResponse) Reset

func (x *DeleteUserDataResponse) Reset()

func (*DeleteUserDataResponse) String

func (x *DeleteUserDataResponse) String() string

type LinkUserDataToTemplateRequest

type LinkUserDataToTemplateRequest struct {

	// the ID of the template for the virtual machine
	TemplateId *int64 `protobuf:"varint,1,opt,name=template_id,json=templateId" json:"template_id,omitempty"`
	// the ID of the ISO for the virtual machine
	IsoId *int64 `protobuf:"varint,2,opt,name=iso_id,json=isoId" json:"iso_id,omitempty"`
	// the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO
	UserdataId *int64 `protobuf:"varint,3,opt,name=userdata_id,json=userdataId" json:"userdata_id,omitempty"`
	// an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride
	UserdataPolicy *string `protobuf:"bytes,4,opt,name=userdata_policy,json=userdataPolicy" json:"userdata_policy,omitempty"`
	ResponseType   *string `protobuf:"bytes,5,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

LinkUserDataToTemplateRequest represents the parameters for link or unlink a userdata to a template.

func (*LinkUserDataToTemplateRequest) Descriptor deprecated

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

Deprecated: Use LinkUserDataToTemplateRequest.ProtoReflect.Descriptor instead.

func (*LinkUserDataToTemplateRequest) GetIsoId

func (x *LinkUserDataToTemplateRequest) GetIsoId() int64

func (*LinkUserDataToTemplateRequest) GetResponseType

func (x *LinkUserDataToTemplateRequest) GetResponseType() string

func (*LinkUserDataToTemplateRequest) GetTemplateId

func (x *LinkUserDataToTemplateRequest) GetTemplateId() int64

func (*LinkUserDataToTemplateRequest) GetUserdataId

func (x *LinkUserDataToTemplateRequest) GetUserdataId() int64

func (*LinkUserDataToTemplateRequest) GetUserdataPolicy

func (x *LinkUserDataToTemplateRequest) GetUserdataPolicy() string

func (*LinkUserDataToTemplateRequest) ProtoMessage

func (*LinkUserDataToTemplateRequest) ProtoMessage()

func (*LinkUserDataToTemplateRequest) ProtoReflect

func (*LinkUserDataToTemplateRequest) Reset

func (x *LinkUserDataToTemplateRequest) Reset()

func (*LinkUserDataToTemplateRequest) String

type LinkUserDataToTemplateResponse

type LinkUserDataToTemplateResponse struct {

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

LinkUserDataToTemplateResponse represents the response from link or unlink a userdata to a template.

func (*LinkUserDataToTemplateResponse) Descriptor deprecated

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

Deprecated: Use LinkUserDataToTemplateResponse.ProtoReflect.Descriptor instead.

func (*LinkUserDataToTemplateResponse) GetResult

func (x *LinkUserDataToTemplateResponse) GetResult() *Result

func (*LinkUserDataToTemplateResponse) ProtoMessage

func (*LinkUserDataToTemplateResponse) ProtoMessage()

func (*LinkUserDataToTemplateResponse) ProtoReflect

func (*LinkUserDataToTemplateResponse) Reset

func (x *LinkUserDataToTemplateResponse) Reset()

func (*LinkUserDataToTemplateResponse) String

type ListUserDataRequest

type ListUserDataRequest struct {

	// the ID of the Userdata
	Id *int64 `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	// Userdata name to look for
	Name *string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// list objects by project; if projectid=-1 lists All VMs
	ProjectId *int64 `protobuf:"varint,3,opt,name=project_id,json=projectId" json:"project_id,omitempty"`
	// list resources by account. Must be used with the domainId parameter.
	AccountName *string `protobuf:"bytes,4,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
	ListAll *bool `protobuf:"varint,5,opt,name=list_all,json=listAll" json:"list_all,omitempty"`
	// list only resources belonging to the domain specified
	DomainId *int64 `protobuf:"varint,6,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	// defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
	Recursive *bool `protobuf:"varint,7,opt,name=recursive" json:"recursive,omitempty"`
	// List by keyword
	Keyword      *string `protobuf:"bytes,8,opt,name=keyword" json:"keyword,omitempty"`
	Page         *int32  `protobuf:"varint,9,opt,name=page" json:"page,omitempty"`
	PageSize     *int32  `protobuf:"varint,10,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	ResponseType *string `protobuf:"bytes,11,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

ListUserDataRequest represents the parameters for list registered userdatas

func (*ListUserDataRequest) Descriptor deprecated

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

Deprecated: Use ListUserDataRequest.ProtoReflect.Descriptor instead.

func (*ListUserDataRequest) GetAccountName

func (x *ListUserDataRequest) GetAccountName() string

func (*ListUserDataRequest) GetDomainId

func (x *ListUserDataRequest) GetDomainId() int64

func (*ListUserDataRequest) GetId

func (x *ListUserDataRequest) GetId() int64

func (*ListUserDataRequest) GetKeyword

func (x *ListUserDataRequest) GetKeyword() string

func (*ListUserDataRequest) GetListAll

func (x *ListUserDataRequest) GetListAll() bool

func (*ListUserDataRequest) GetName

func (x *ListUserDataRequest) GetName() string

func (*ListUserDataRequest) GetPage

func (x *ListUserDataRequest) GetPage() int32

func (*ListUserDataRequest) GetPageSize

func (x *ListUserDataRequest) GetPageSize() int32

func (*ListUserDataRequest) GetProjectId

func (x *ListUserDataRequest) GetProjectId() int64

func (*ListUserDataRequest) GetRecursive

func (x *ListUserDataRequest) GetRecursive() bool

func (*ListUserDataRequest) GetResponseType

func (x *ListUserDataRequest) GetResponseType() string

func (*ListUserDataRequest) ProtoMessage

func (*ListUserDataRequest) ProtoMessage()

func (*ListUserDataRequest) ProtoReflect

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

func (*ListUserDataRequest) Reset

func (x *ListUserDataRequest) Reset()

func (*ListUserDataRequest) String

func (x *ListUserDataRequest) String() string

type ListUserDataResponse

type ListUserDataResponse struct {

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

ListUserDataResponse represents the response from list registered userdatas

func (*ListUserDataResponse) Descriptor deprecated

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

Deprecated: Use ListUserDataResponse.ProtoReflect.Descriptor instead.

func (*ListUserDataResponse) GetItems

func (x *ListUserDataResponse) GetItems() []*UserData

func (*ListUserDataResponse) GetTotalCount

func (x *ListUserDataResponse) GetTotalCount() int32

func (*ListUserDataResponse) ProtoMessage

func (*ListUserDataResponse) ProtoMessage()

func (*ListUserDataResponse) ProtoReflect

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

func (*ListUserDataResponse) Reset

func (x *ListUserDataResponse) Reset()

func (*ListUserDataResponse) String

func (x *ListUserDataResponse) String() string

type RegisterUserDataRequest

type RegisterUserDataRequest struct {

	// Name of the userdata
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// an optional account for the userdata. Must be used with domainId.
	AccountName *string `protobuf:"bytes,2,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// an optional domainId for the userdata. If the account parameter is used, domainId must also be used.
	DomainId *int64 `protobuf:"varint,3,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	// an optional project for the userdata
	ProjectId *int64 `protobuf:"varint,4,opt,name=project_id,json=projectId" json:"project_id,omitempty"`
	// Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
	UserData *string `protobuf:"bytes,5,opt,name=user_data,json=userData" json:"user_data,omitempty"`
	// comma separated list of variables declared in userdata content
	Params       *string `protobuf:"bytes,6,opt,name=params" json:"params,omitempty"`
	ResponseType *string `protobuf:"bytes,7,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

RegisterUserDataRequest represents the parameters for register a new userdata.

func (*RegisterUserDataRequest) Descriptor deprecated

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

Deprecated: Use RegisterUserDataRequest.ProtoReflect.Descriptor instead.

func (*RegisterUserDataRequest) GetAccountName

func (x *RegisterUserDataRequest) GetAccountName() string

func (*RegisterUserDataRequest) GetDomainId

func (x *RegisterUserDataRequest) GetDomainId() int64

func (*RegisterUserDataRequest) GetName

func (x *RegisterUserDataRequest) GetName() string

func (*RegisterUserDataRequest) GetParams

func (x *RegisterUserDataRequest) GetParams() string

func (*RegisterUserDataRequest) GetProjectId

func (x *RegisterUserDataRequest) GetProjectId() int64

func (*RegisterUserDataRequest) GetResponseType

func (x *RegisterUserDataRequest) GetResponseType() string

func (*RegisterUserDataRequest) GetUserData

func (x *RegisterUserDataRequest) GetUserData() string

func (*RegisterUserDataRequest) ProtoMessage

func (*RegisterUserDataRequest) ProtoMessage()

func (*RegisterUserDataRequest) ProtoReflect

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

func (*RegisterUserDataRequest) Reset

func (x *RegisterUserDataRequest) Reset()

func (*RegisterUserDataRequest) String

func (x *RegisterUserDataRequest) String() string

type RegisterUserDataResponse

type RegisterUserDataResponse struct {

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

RegisterUserDataResponse represents the response from register a new userdata.

func (*RegisterUserDataResponse) Descriptor deprecated

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

Deprecated: Use RegisterUserDataResponse.ProtoReflect.Descriptor instead.

func (*RegisterUserDataResponse) GetResult

func (x *RegisterUserDataResponse) GetResult() *Result

func (*RegisterUserDataResponse) ProtoMessage

func (*RegisterUserDataResponse) ProtoMessage()

func (*RegisterUserDataResponse) ProtoReflect

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

func (*RegisterUserDataResponse) Reset

func (x *RegisterUserDataResponse) Reset()

func (*RegisterUserDataResponse) String

func (x *RegisterUserDataResponse) 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 UnimplementedUserdataServiceServer

type UnimplementedUserdataServiceServer struct{}

UnimplementedUserdataServiceServer 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 (UnimplementedUserdataServiceServer) DeleteUserData

func (UnimplementedUserdataServiceServer) ListUserData

func (UnimplementedUserdataServiceServer) RegisterUserData

type UnsafeUserdataServiceServer

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

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

type UserData

type UserData struct {

	// The ID of the UserData
	Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The name of the UserData
	Name *string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The display name of the UserData
	DisplayName *string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// The description of the UserData
	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
}

UserData represents a UserData Item

func (*UserData) Descriptor deprecated

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

Deprecated: Use UserData.ProtoReflect.Descriptor instead.

func (*UserData) GetCreated

func (x *UserData) GetCreated() string

func (*UserData) GetDescription

func (x *UserData) GetDescription() string

func (*UserData) GetDisplayName

func (x *UserData) GetDisplayName() string

func (*UserData) GetId

func (x *UserData) GetId() string

func (*UserData) GetName

func (x *UserData) GetName() string

func (*UserData) ProtoMessage

func (*UserData) ProtoMessage()

func (*UserData) ProtoReflect

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

func (*UserData) Reset

func (x *UserData) Reset()

func (*UserData) String

func (x *UserData) String() string

type UserdataServiceClient

type UserdataServiceClient interface {
	// DeleteUserData Deletes a userdata
	DeleteUserData(ctx context.Context, in *DeleteUserDataRequest, opts ...grpc.CallOption) (*DeleteUserDataResponse, error)
	// LinkUserDataToTemplate Link or unlink a userdata to a template.
	LinkUserDataToTemplate(ctx context.Context, in *LinkUserDataToTemplateRequest, opts ...grpc.CallOption) (*LinkUserDataToTemplateResponse, error)
	// ListUserData List registered userdatas
	ListUserData(ctx context.Context, in *ListUserDataRequest, opts ...grpc.CallOption) (*ListUserDataResponse, error)
	// RegisterUserData Register a new userdata.
	RegisterUserData(ctx context.Context, in *RegisterUserDataRequest, opts ...grpc.CallOption) (*RegisterUserDataResponse, error)
}

UserdataServiceClient is the client API for UserdataService 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.

UserdataService provides operations for managing Userdatas

type UserdataServiceServer

type UserdataServiceServer interface {
	// DeleteUserData Deletes a userdata
	DeleteUserData(context.Context, *DeleteUserDataRequest) (*DeleteUserDataResponse, error)
	// LinkUserDataToTemplate Link or unlink a userdata to a template.
	LinkUserDataToTemplate(context.Context, *LinkUserDataToTemplateRequest) (*LinkUserDataToTemplateResponse, error)
	// ListUserData List registered userdatas
	ListUserData(context.Context, *ListUserDataRequest) (*ListUserDataResponse, error)
	// RegisterUserData Register a new userdata.
	RegisterUserData(context.Context, *RegisterUserDataRequest) (*RegisterUserDataResponse, error)
	// contains filtered or unexported methods
}

UserdataServiceServer is the server API for UserdataService service. All implementations must embed UnimplementedUserdataServiceServer for forward compatibility.

UserdataService provides operations for managing Userdatas

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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