client

jumpstarter.client.v1

Services

ClientService

Client-facing API service for managing exporters and leases.

Method	Request	Response	Description
GetExporter	GetExporterRequest	Exporter	Retrieve a single exporter by resource name.
ListExporters	ListExportersRequest	ListExportersResponse	List exporters in a namespace with optional filtering.
GetLease	GetLeaseRequest	Lease	Retrieve a single lease by resource name.
ListLeases	ListLeasesRequest	ListLeasesResponse	List leases in a namespace with optional filtering.
CreateLease	CreateLeaseRequest	Lease	Create a new lease for an exporter.
UpdateLease	UpdateLeaseRequest	Lease	Update an existing lease.
DeleteLease	DeleteLeaseRequest	google.protobuf.Empty	Delete a lease by resource name.
RotateToken	RotateTokenRequest	RotateTokenResponse	Rotate the authentication token for the client.

Messages

Exporter

An exporter resource representing a registered device provider.

Field	Number	Type	Label	Description
name	1	string		The resource name of the exporter.
labels	2	map<string, string>		The set of labels associated with the exporter.
online	3	bool		Whether the exporter is currently online. Deprecated in favor of the status field.
status	4	jumpstarter.v1.ExporterStatus		The current status of the exporter.
status_message	5	string		A human-readable message providing details about the exporter status.

Lease

A lease resource representing a reservation of an exporter.

Field	Number	Type	Label	Description
name	1	string		The resource name of the lease.
selector	2	string		The label selector expression used to match an exporter.
duration	3	google.protobuf.Duration	optional	The requested duration of the lease.
effective_duration	4	google.protobuf.Duration		The server-computed effective duration of the lease.
begin_time	5	google.protobuf.Timestamp	optional	The requested begin time of the lease.
effective_begin_time	6	google.protobuf.Timestamp	optional	The server-computed effective begin time of the lease.
end_time	7	google.protobuf.Timestamp	optional	The requested end time of the lease.
effective_end_time	8	google.protobuf.Timestamp	optional	The server-computed effective end time of the lease.
client	9	string	optional	The resource name of the client that owns this lease.
exporter	10	string	optional	The resource name of the exporter assigned to this lease.
conditions	11	jumpstarter.v1.Condition	repeated	The list of conditions reflecting the current state of the lease.
exporter_name	12	string	optional	The name of a specific exporter to target for the lease.

GetExporterRequest

Request to retrieve an exporter.

Field	Number	Type	Label	Description
name	1	string		The resource name of the exporter.

ListExportersRequest

Request to list exporters.

Field	Number	Type	Label	Description
parent	1	string		The parent resource name (namespace).
page_size	2	int32		Maximum number of results to return.
page_token	3	string		Token for retrieving the next page of results.
filter	4	string		Filter expression for the results.

ListExportersResponse

Response containing a list of exporters.

Field	Number	Type	Label	Description
exporters	1	Exporter	repeated	The list of exporters.
next_page_token	2	string		Token for the next page of results.

GetLeaseRequest

Request to retrieve a lease.

Field	Number	Type	Label	Description
name	1	string		The resource name of the lease.

ListLeasesRequest

Request to list leases.

Field	Number	Type	Label	Description
parent	1	string		The parent resource name (namespace).
page_size	2	int32		Maximum number of results to return.
page_token	3	string		Token for retrieving the next page of results.
filter	4	string		Filter expression for the results.
only_active	5	bool	optional	If true, return only active leases.
tag_filter	6	string		Filter expression for lease tags.

ListLeasesResponse

Response containing a list of leases.

Field	Number	Type	Label	Description
leases	1	Lease	repeated	The list of leases.
next_page_token	2	string		Token for the next page of results.

CreateLeaseRequest

Request to create a lease.

Field	Number	Type	Label	Description
parent	1	string		The parent resource name (namespace).
lease_id	2	string		The client-assigned identifier for the lease.
lease	3	Lease		The lease resource to create.

UpdateLeaseRequest

Request to update a lease.

Field	Number	Type	Label	Description
lease	1	Lease		The lease resource with updated fields.
update_mask	2	google.protobuf.FieldMask		The set of fields to update.

DeleteLeaseRequest

Request to delete a lease.

Field	Number	Type	Label	Description
name	1	string		The resource name of the lease.

RotateTokenRequest

Request to rotate the authentication token for a client.

Field	Number	Type	Label	Description
parent	1	string		The parent resource name (namespace).

RotateTokenResponse

Response containing the newly rotated token.

Field	Number	Type	Label	Description
token	1	string		The new authentication token.
expiry	2	google.protobuf.Timestamp		The expiration time of the new token.