Package cloud.google.com/go/oslogin/apiv1beta/osloginpb (v1.4.0)

Variables

File_google_cloud_oslogin_v1beta_oslogin_proto

var File_google_cloud_oslogin_v1beta_oslogin_proto protoreflect.FileDescriptor

Functions

func RegisterOsLoginServiceServer

func RegisterOsLoginServiceServer(s *grpc.Server, srv OsLoginServiceServer)

DeletePosixAccountRequest

type DeletePosixAccountRequest struct {

	// Required. A reference to the POSIX account to update. POSIX accounts are identified
	// by the project ID they are associated with. A reference to the POSIX
	// account is in format `users/{user}/projects/{project}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for deleting a POSIX account entry.

func (*DeletePosixAccountRequest) Descriptor

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

Deprecated: Use DeletePosixAccountRequest.ProtoReflect.Descriptor instead.

func (*DeletePosixAccountRequest) GetName

func (x *DeletePosixAccountRequest) GetName() string

func (*DeletePosixAccountRequest) ProtoMessage

func (*DeletePosixAccountRequest) ProtoMessage()

func (*DeletePosixAccountRequest) ProtoReflect

func (*DeletePosixAccountRequest) Reset

func (x *DeletePosixAccountRequest) Reset()

func (*DeletePosixAccountRequest) String

func (x *DeletePosixAccountRequest) String() string

DeleteSshPublicKeyRequest

type DeleteSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to update. Public keys are identified by
	// their SHA-256 fingerprint. The fingerprint of the public key is in format
	// `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for deleting an SSH public key.

func (*DeleteSshPublicKeyRequest) Descriptor

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

Deprecated: Use DeleteSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteSshPublicKeyRequest) GetName

func (x *DeleteSshPublicKeyRequest) GetName() string

func (*DeleteSshPublicKeyRequest) ProtoMessage

func (*DeleteSshPublicKeyRequest) ProtoMessage()

func (*DeleteSshPublicKeyRequest) ProtoReflect

func (*DeleteSshPublicKeyRequest) Reset

func (x *DeleteSshPublicKeyRequest) Reset()

func (*DeleteSshPublicKeyRequest) String

func (x *DeleteSshPublicKeyRequest) String() string

GetLoginProfileRequest

type GetLoginProfileRequest struct {

	// Required. The unique ID for the user in format `users/{user}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The project ID of the Google Cloud Platform project.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// A system ID for filtering the results of the request.
	SystemId string `protobuf:"bytes,3,opt,name=system_id,json=systemId,proto3" json:"system_id,omitempty"`
	// contains filtered or unexported fields
}

A request message for retrieving the login profile information for a user.

func (*GetLoginProfileRequest) Descriptor

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

Deprecated: Use GetLoginProfileRequest.ProtoReflect.Descriptor instead.

func (*GetLoginProfileRequest) GetName

func (x *GetLoginProfileRequest) GetName() string

func (*GetLoginProfileRequest) GetProjectId

func (x *GetLoginProfileRequest) GetProjectId() string

func (*GetLoginProfileRequest) GetSystemId

func (x *GetLoginProfileRequest) GetSystemId() string

func (*GetLoginProfileRequest) ProtoMessage

func (*GetLoginProfileRequest) ProtoMessage()

func (*GetLoginProfileRequest) ProtoReflect

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

func (*GetLoginProfileRequest) Reset

func (x *GetLoginProfileRequest) Reset()

func (*GetLoginProfileRequest) String

func (x *GetLoginProfileRequest) String() string

GetSshPublicKeyRequest

type GetSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to retrieve. Public keys are identified
	// by their SHA-256 fingerprint. The fingerprint of the public key is in
	// format `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for retrieving an SSH public key.

func (*GetSshPublicKeyRequest) Descriptor

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

Deprecated: Use GetSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*GetSshPublicKeyRequest) GetName

func (x *GetSshPublicKeyRequest) GetName() string

func (*GetSshPublicKeyRequest) ProtoMessage

func (*GetSshPublicKeyRequest) ProtoMessage()

func (*GetSshPublicKeyRequest) ProtoReflect

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

func (*GetSshPublicKeyRequest) Reset

func (x *GetSshPublicKeyRequest) Reset()

func (*GetSshPublicKeyRequest) String

func (x *GetSshPublicKeyRequest) String() string

ImportSshPublicKeyRequest

type ImportSshPublicKeyRequest struct {

	// The unique ID for the user in format `users/{user}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The SSH public key and expiration time.
	SshPublicKey *common.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"`
	// The project ID of the Google Cloud Platform project.
	ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

A request message for importing an SSH public key.

func (*ImportSshPublicKeyRequest) Descriptor

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

Deprecated: Use ImportSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*ImportSshPublicKeyRequest) GetParent

func (x *ImportSshPublicKeyRequest) GetParent() string

func (*ImportSshPublicKeyRequest) GetProjectId

func (x *ImportSshPublicKeyRequest) GetProjectId() string

func (*ImportSshPublicKeyRequest) GetSshPublicKey

func (x *ImportSshPublicKeyRequest) GetSshPublicKey() *common.SshPublicKey

func (*ImportSshPublicKeyRequest) ProtoMessage

func (*ImportSshPublicKeyRequest) ProtoMessage()

func (*ImportSshPublicKeyRequest) ProtoReflect

func (*ImportSshPublicKeyRequest) Reset

func (x *ImportSshPublicKeyRequest) Reset()

func (*ImportSshPublicKeyRequest) String

func (x *ImportSshPublicKeyRequest) String() string

ImportSshPublicKeyResponse

type ImportSshPublicKeyResponse struct {

	// The login profile information for the user.
	LoginProfile *LoginProfile `protobuf:"bytes,1,opt,name=login_profile,json=loginProfile,proto3" json:"login_profile,omitempty"`
	// contains filtered or unexported fields
}

A response message for importing an SSH public key.

func (*ImportSshPublicKeyResponse) Descriptor

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

Deprecated: Use ImportSshPublicKeyResponse.ProtoReflect.Descriptor instead.

func (*ImportSshPublicKeyResponse) GetLoginProfile

func (x *ImportSshPublicKeyResponse) GetLoginProfile() *LoginProfile

func (*ImportSshPublicKeyResponse) ProtoMessage

func (*ImportSshPublicKeyResponse) ProtoMessage()

func (*ImportSshPublicKeyResponse) ProtoReflect

func (*ImportSshPublicKeyResponse) Reset

func (x *ImportSshPublicKeyResponse) Reset()

func (*ImportSshPublicKeyResponse) String

func (x *ImportSshPublicKeyResponse) String() string

LoginProfile

type LoginProfile struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	PosixAccounts []*common.PosixAccount `protobuf:"bytes,2,rep,name=posix_accounts,json=posixAccounts,proto3" json:"posix_accounts,omitempty"`

	SshPublicKeys map[string]*common.SshPublicKey "" /* 190 byte string literal not displayed */

}

The user profile information used for logging in to a virtual machine on Google Compute Engine.

func (*LoginProfile) Descriptor

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

Deprecated: Use LoginProfile.ProtoReflect.Descriptor instead.

func (*LoginProfile) GetName

func (x *LoginProfile) GetName() string

func (*LoginProfile) GetPosixAccounts

func (x *LoginProfile) GetPosixAccounts() []*common.PosixAccount

func (*LoginProfile) GetSshPublicKeys

func (x *LoginProfile) GetSshPublicKeys() map[string]*common.SshPublicKey

func (*LoginProfile) ProtoMessage

func (*LoginProfile) ProtoMessage()

func (*LoginProfile) ProtoReflect

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

func (*LoginProfile) Reset

func (x *LoginProfile) Reset()

func (*LoginProfile) String

func (x *LoginProfile) String() string

OsLoginServiceClient

type OsLoginServiceClient interface {
	// Deletes a POSIX account.
	DeletePosixAccount(ctx context.Context, in *DeletePosixAccountRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deletes an SSH public key.
	DeleteSshPublicKey(ctx context.Context, in *DeleteSshPublicKeyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Retrieves the profile information used for logging in to a virtual machine
	// on Google Compute Engine.
	GetLoginProfile(ctx context.Context, in *GetLoginProfileRequest, opts ...grpc.CallOption) (*LoginProfile, error)
	// Retrieves an SSH public key.
	GetSshPublicKey(ctx context.Context, in *GetSshPublicKeyRequest, opts ...grpc.CallOption) (*common.SshPublicKey, error)
	// Adds an SSH public key and returns the profile information. Default POSIX
	// account information is set when no username and UID exist as part of the
	// login profile.
	ImportSshPublicKey(ctx context.Context, in *ImportSshPublicKeyRequest, opts ...grpc.CallOption) (*ImportSshPublicKeyResponse, error)
	// Updates an SSH public key and returns the profile information. This method
	// supports patch semantics.
	UpdateSshPublicKey(ctx context.Context, in *UpdateSshPublicKeyRequest, opts ...grpc.CallOption) (*common.SshPublicKey, error)
}

OsLoginServiceClient is the client API for OsLoginService service.

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

func NewOsLoginServiceClient

func NewOsLoginServiceClient(cc grpc.ClientConnInterface) OsLoginServiceClient

OsLoginServiceServer

type OsLoginServiceServer interface {
	// Deletes a POSIX account.
	DeletePosixAccount(context.Context, *DeletePosixAccountRequest) (*emptypb.Empty, error)
	// Deletes an SSH public key.
	DeleteSshPublicKey(context.Context, *DeleteSshPublicKeyRequest) (*emptypb.Empty, error)
	// Retrieves the profile information used for logging in to a virtual machine
	// on Google Compute Engine.
	GetLoginProfile(context.Context, *GetLoginProfileRequest) (*LoginProfile, error)
	// Retrieves an SSH public key.
	GetSshPublicKey(context.Context, *GetSshPublicKeyRequest) (*common.SshPublicKey, error)
	// Adds an SSH public key and returns the profile information. Default POSIX
	// account information is set when no username and UID exist as part of the
	// login profile.
	ImportSshPublicKey(context.Context, *ImportSshPublicKeyRequest) (*ImportSshPublicKeyResponse, error)
	// Updates an SSH public key and returns the profile information. This method
	// supports patch semantics.
	UpdateSshPublicKey(context.Context, *UpdateSshPublicKeyRequest) (*common.SshPublicKey, error)
}

OsLoginServiceServer is the server API for OsLoginService service.

UnimplementedOsLoginServiceServer

type UnimplementedOsLoginServiceServer struct {
}

UnimplementedOsLoginServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedOsLoginServiceServer) DeletePosixAccount

func (*UnimplementedOsLoginServiceServer) DeleteSshPublicKey

func (*UnimplementedOsLoginServiceServer) GetLoginProfile

func (*UnimplementedOsLoginServiceServer) GetSshPublicKey

func (*UnimplementedOsLoginServiceServer) ImportSshPublicKey

func (*UnimplementedOsLoginServiceServer) UpdateSshPublicKey

UpdateSshPublicKeyRequest

type UpdateSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to update. Public keys are identified by
	// their SHA-256 fingerprint. The fingerprint of the public key is in format
	// `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The SSH public key and expiration time.
	SshPublicKey *common.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"`
	// Mask to control which fields get updated. Updates all if not present.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

A request message for updating an SSH public key.

func (*UpdateSshPublicKeyRequest) Descriptor

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

Deprecated: Use UpdateSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateSshPublicKeyRequest) GetName

func (x *UpdateSshPublicKeyRequest) GetName() string

func (*UpdateSshPublicKeyRequest) GetSshPublicKey

func (x *UpdateSshPublicKeyRequest) GetSshPublicKey() *common.SshPublicKey

func (*UpdateSshPublicKeyRequest) GetUpdateMask

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

func (*UpdateSshPublicKeyRequest) ProtoMessage

func (*UpdateSshPublicKeyRequest) ProtoMessage()

func (*UpdateSshPublicKeyRequest) ProtoReflect

func (*UpdateSshPublicKeyRequest) Reset

func (x *UpdateSshPublicKeyRequest) Reset()

func (*UpdateSshPublicKeyRequest) String

func (x *UpdateSshPublicKeyRequest) String() string