users

package
v0.0.0-...-204702d Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	UserService_Create_FullMethodName = "/yandex.cloud.ai.assistants.v1.users.UserService/Create"
	UserService_Get_FullMethodName    = "/yandex.cloud.ai.assistants.v1.users.UserService/Get"
	UserService_Update_FullMethodName = "/yandex.cloud.ai.assistants.v1.users.UserService/Update"
	UserService_Delete_FullMethodName = "/yandex.cloud.ai.assistants.v1.users.UserService/Delete"
	UserService_List_FullMethodName   = "/yandex.cloud.ai.assistants.v1.users.UserService/List"
)

Variables

View Source 
var File_yandex_cloud_ai_assistants_v1_users_user_proto protoreflect.FileDescriptor
View Source 
var File_yandex_cloud_ai_assistants_v1_users_user_service_proto protoreflect.FileDescriptor
View Source 
var UserService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yandex.cloud.ai.assistants.v1.users.UserService",
	HandlerType: (*UserServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _UserService_Create_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _UserService_Get_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _UserService_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _UserService_Delete_Handler,
		},
		{
			MethodName: "List",
			Handler:    _UserService_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "yandex/cloud/ai/assistants/v1/users/user_service.proto",
}

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

Functions

func RegisterUserServiceServer 

func RegisterUserServiceServer(s grpc.ServiceRegistrar, srv UserServiceServer)

Types

type CreateUserRequest 

type CreateUserRequest struct {
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Name of the user.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the user.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Source      string `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
	// Expiration configuration for the user.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,5,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// Set of key-value pairs to label the user.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for creating a new user.

func (*CreateUserRequest) Descriptor deprecated 

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

Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.

func (*CreateUserRequest) GetDescription 

func (x *CreateUserRequest) GetDescription() string

func (*CreateUserRequest) GetExpirationConfig 

func (x *CreateUserRequest) GetExpirationConfig() *common.ExpirationConfig

func (*CreateUserRequest) GetFolderId 

func (x *CreateUserRequest) GetFolderId() string

func (*CreateUserRequest) GetLabels 

func (x *CreateUserRequest) GetLabels() map[string]string

func (*CreateUserRequest) GetName 

func (x *CreateUserRequest) GetName() string

func (*CreateUserRequest) GetSource 

func (x *CreateUserRequest) GetSource() string

func (*CreateUserRequest) ProtoMessage 

func (*CreateUserRequest) ProtoMessage()

func (*CreateUserRequest) ProtoReflect 

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

func (*CreateUserRequest) Reset 

func (x *CreateUserRequest) Reset()

func (*CreateUserRequest) SetDescription 

func (m *CreateUserRequest) SetDescription(v string)

func (*CreateUserRequest) SetExpirationConfig 

func (m *CreateUserRequest) SetExpirationConfig(v *common.ExpirationConfig)

func (*CreateUserRequest) SetFolderId 

func (m *CreateUserRequest) SetFolderId(v string)

func (*CreateUserRequest) SetLabels 

func (m *CreateUserRequest) SetLabels(v map[string]string)

func (*CreateUserRequest) SetName 

func (m *CreateUserRequest) SetName(v string)

func (*CreateUserRequest) SetSource 

func (m *CreateUserRequest) SetSource(v string)

func (*CreateUserRequest) String 

func (x *CreateUserRequest) String() string

type DeleteUserRequest 

type DeleteUserRequest struct {

	// ID of the user to delete.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for deleting a user by ID.

func (*DeleteUserRequest) Descriptor deprecated 

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

Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserRequest) GetUserId 

func (x *DeleteUserRequest) GetUserId() string

func (*DeleteUserRequest) ProtoMessage 

func (*DeleteUserRequest) ProtoMessage()

func (*DeleteUserRequest) ProtoReflect 

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

func (*DeleteUserRequest) Reset 

func (x *DeleteUserRequest) Reset()

func (*DeleteUserRequest) SetUserId 

func (m *DeleteUserRequest) SetUserId(v string)

func (*DeleteUserRequest) String 

func (x *DeleteUserRequest) String() string

type DeleteUserResponse 

type DeleteUserResponse struct {
	// contains filtered or unexported fields
}

Response message for the delete operation.

func (*DeleteUserResponse) Descriptor deprecated 

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

Deprecated: Use DeleteUserResponse.ProtoReflect.Descriptor instead.

func (*DeleteUserResponse) ProtoMessage 

func (*DeleteUserResponse) ProtoMessage()

func (*DeleteUserResponse) ProtoReflect 

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

func (*DeleteUserResponse) Reset 

func (x *DeleteUserResponse) Reset()

func (*DeleteUserResponse) String 

func (x *DeleteUserResponse) String() string

type GetUserRequest 

type GetUserRequest struct {

	// ID of the user to retrieve.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for retrieving a user by ID.

func (*GetUserRequest) Descriptor deprecated 

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) GetUserId 

func (x *GetUserRequest) GetUserId() string

func (*GetUserRequest) ProtoMessage 

func (*GetUserRequest) ProtoMessage()

func (*GetUserRequest) ProtoReflect 

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

func (*GetUserRequest) Reset 

func (x *GetUserRequest) Reset()

func (*GetUserRequest) SetUserId 

func (m *GetUserRequest) SetUserId(v string)

func (*GetUserRequest) String 

func (x *GetUserRequest) String() string

type ListUsersRequest 

type ListUsersRequest struct {

	// Folder ID from which to list users.
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Maximum number of users to return per page.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token to retrieve the next page of results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for listing users in a specific folder.

func (*ListUsersRequest) Descriptor deprecated 

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

Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.

func (*ListUsersRequest) GetFolderId 

func (x *ListUsersRequest) GetFolderId() string

func (*ListUsersRequest) GetPageSize 

func (x *ListUsersRequest) GetPageSize() int64

func (*ListUsersRequest) GetPageToken 

func (x *ListUsersRequest) GetPageToken() string

func (*ListUsersRequest) ProtoMessage 

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) ProtoReflect 

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

func (*ListUsersRequest) Reset 

func (x *ListUsersRequest) Reset()

func (*ListUsersRequest) SetFolderId 

func (m *ListUsersRequest) SetFolderId(v string)

func (*ListUsersRequest) SetPageSize 

func (m *ListUsersRequest) SetPageSize(v int64)

func (*ListUsersRequest) SetPageToken 

func (m *ListUsersRequest) SetPageToken(v string)

func (*ListUsersRequest) String 

func (x *ListUsersRequest) String() string

type ListUsersResponse 

type ListUsersResponse struct {

	// List of users in the specified folder.
	Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// Token to retrieve the next page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the list operation.

func (*ListUsersResponse) Descriptor deprecated 

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

Deprecated: Use ListUsersResponse.ProtoReflect.Descriptor instead.

func (*ListUsersResponse) GetNextPageToken 

func (x *ListUsersResponse) GetNextPageToken() string

func (*ListUsersResponse) GetUsers 

func (x *ListUsersResponse) GetUsers() []*User

func (*ListUsersResponse) ProtoMessage 

func (*ListUsersResponse) ProtoMessage()

func (*ListUsersResponse) ProtoReflect 

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

func (*ListUsersResponse) Reset 

func (x *ListUsersResponse) Reset()

func (*ListUsersResponse) SetNextPageToken 

func (m *ListUsersResponse) SetNextPageToken(v string)

func (*ListUsersResponse) SetUsers 

func (m *ListUsersResponse) SetUsers(v []*User)

func (*ListUsersResponse) String 

func (x *ListUsersResponse) String() string

type UnimplementedUserServiceServer 

type UnimplementedUserServiceServer struct{}

UnimplementedUserServiceServer should 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 (UnimplementedUserServiceServer) Create 

func (UnimplementedUserServiceServer) Create(context.Context, *CreateUserRequest) (*User, error)

func (UnimplementedUserServiceServer) Delete 

func (UnimplementedUserServiceServer) Delete(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)

func (UnimplementedUserServiceServer) Get 

func (UnimplementedUserServiceServer) Get(context.Context, *GetUserRequest) (*User, error)

func (UnimplementedUserServiceServer) List 

func (UnimplementedUserServiceServer) List(context.Context, *ListUsersRequest) (*ListUsersResponse, error)

func (UnimplementedUserServiceServer) Update 

func (UnimplementedUserServiceServer) Update(context.Context, *UpdateUserRequest) (*User, error)

type UnsafeUserServiceServer 

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

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

type UpdateUserRequest 

type UpdateUserRequest struct {

	// ID of the user to update.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// A field mask specifying which fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// New name for the user.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// New description for the user.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// New expiration configuration for the user.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,5,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// New set of labels for the user.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for updating an existing user.

func (*UpdateUserRequest) Descriptor deprecated 

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

Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.

func (*UpdateUserRequest) GetDescription 

func (x *UpdateUserRequest) GetDescription() string

func (*UpdateUserRequest) GetExpirationConfig 

func (x *UpdateUserRequest) GetExpirationConfig() *common.ExpirationConfig

func (*UpdateUserRequest) GetLabels 

func (x *UpdateUserRequest) GetLabels() map[string]string

func (*UpdateUserRequest) GetName 

func (x *UpdateUserRequest) GetName() string

func (*UpdateUserRequest) GetUpdateMask 

func (x *UpdateUserRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateUserRequest) GetUserId 

func (x *UpdateUserRequest) GetUserId() string

func (*UpdateUserRequest) ProtoMessage 

func (*UpdateUserRequest) ProtoMessage()

func (*UpdateUserRequest) ProtoReflect 

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

func (*UpdateUserRequest) Reset 

func (x *UpdateUserRequest) Reset()

func (*UpdateUserRequest) SetDescription 

func (m *UpdateUserRequest) SetDescription(v string)

func (*UpdateUserRequest) SetExpirationConfig 

func (m *UpdateUserRequest) SetExpirationConfig(v *common.ExpirationConfig)

func (*UpdateUserRequest) SetLabels 

func (m *UpdateUserRequest) SetLabels(v map[string]string)

func (*UpdateUserRequest) SetName 

func (m *UpdateUserRequest) SetName(v string)

func (*UpdateUserRequest) SetUpdateMask 

func (m *UpdateUserRequest) SetUpdateMask(v *fieldmaskpb.FieldMask)

func (*UpdateUserRequest) SetUserId 

func (m *UpdateUserRequest) SetUserId(v string)

func (*UpdateUserRequest) String 

func (x *UpdateUserRequest) String() string

type User 

type User struct {

	// Unique identifier of the user.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the folder that the user belongs to.
	FolderId string `protobuf:"bytes,2,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Name of the user.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the user.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	Source      string `protobuf:"bytes,5,opt,name=source,proto3" json:"source,omitempty"`
	// Identifier of the subject who created this user.
	CreatedBy string `protobuf:"bytes,6,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Timestamp representing when the user was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Identifier of the subject who last updated this user.
	UpdatedBy string `protobuf:"bytes,8,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Timestamp representing the last time this user was updated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Configuration for the expiration of the user, defining when and how the user will expire.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,10,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// Timestamp representing when the user will expire.
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Set of key-value pairs that can be used to organize and categorize the user.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetCreatedAt 

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

func (*User) GetCreatedBy 

func (x *User) GetCreatedBy() string

func (*User) GetDescription 

func (x *User) GetDescription() string

func (*User) GetExpirationConfig 

func (x *User) GetExpirationConfig() *common.ExpirationConfig

func (*User) GetExpiresAt 

func (x *User) GetExpiresAt() *timestamppb.Timestamp

func (*User) GetFolderId 

func (x *User) GetFolderId() string

func (*User) GetId 

func (x *User) GetId() string

func (*User) GetLabels 

func (x *User) GetLabels() map[string]string

func (*User) GetName 

func (x *User) GetName() string

func (*User) GetSource 

func (x *User) GetSource() string

func (*User) GetUpdatedAt 

func (x *User) GetUpdatedAt() *timestamppb.Timestamp

func (*User) GetUpdatedBy 

func (x *User) GetUpdatedBy() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

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

func (*User) Reset 

func (x *User) Reset()

func (*User) SetCreatedAt 

func (m *User) SetCreatedAt(v *timestamppb.Timestamp)

func (*User) SetCreatedBy 

func (m *User) SetCreatedBy(v string)

func (*User) SetDescription 

func (m *User) SetDescription(v string)

func (*User) SetExpirationConfig 

func (m *User) SetExpirationConfig(v *common.ExpirationConfig)

func (*User) SetExpiresAt 

func (m *User) SetExpiresAt(v *timestamppb.Timestamp)

func (*User) SetFolderId 

func (m *User) SetFolderId(v string)

func (*User) SetId 

func (m *User) SetId(v string)

func (*User) SetLabels 

func (m *User) SetLabels(v map[string]string)

func (*User) SetName 

func (m *User) SetName(v string)

func (*User) SetSource 

func (m *User) SetSource(v string)

func (*User) SetUpdatedAt 

func (m *User) SetUpdatedAt(v *timestamppb.Timestamp)

func (*User) SetUpdatedBy 

func (m *User) SetUpdatedBy(v string)

func (*User) String 

func (x *User) String() string

type UserServiceClient 

type UserServiceClient interface {
	// Create a new user.
	Create(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*User, error)
	// Retrieve details of a specific user by its ID.
	Get(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*User, error)
	// Update an existing user.
	Update(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*User, error)
	// Delete a user by its ID.
	Delete(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*DeleteUserResponse, error)
	// List users in a specific folder.
	List(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)
}

UserServiceClient is the client API for UserService 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.

UserService provides operations for managing users.

func NewUserServiceClient 

func NewUserServiceClient(cc grpc.ClientConnInterface) UserServiceClient

type UserServiceServer 

type UserServiceServer interface {
	// Create a new user.
	Create(context.Context, *CreateUserRequest) (*User, error)
	// Retrieve details of a specific user by its ID.
	Get(context.Context, *GetUserRequest) (*User, error)
	// Update an existing user.
	Update(context.Context, *UpdateUserRequest) (*User, error)
	// Delete a user by its ID.
	Delete(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)
	// List users in a specific folder.
	List(context.Context, *ListUsersRequest) (*ListUsersResponse, error)
}

UserServiceServer is the server API for UserService service. All implementations should embed UnimplementedUserServiceServer for forward compatibility.

UserService provides operations for managing users.

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.