Method: remoteAgents.fetchRemoteAgentsCompatibleWithJobs

Full name: projects.locations.instances.remoteAgents.fetchRemoteAgentsCompatibleWithJobs

Return a list of all the remote agents with availability status for jobs on specific integration. Compatible with jobs means that the agent is in a state to take a job.

HTTP request


Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
integration

string

Required. An integration name. Used to check whether the remote agent requires integration.

Request body

The request body must be empty.

Response body

Response message for the remoteAgents.fetchRemoteAgentsCompatibleWithJobs method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "compatibleRemoteAgents": [
    {
      object (RemoteAgentCompatibleWithJobs)
    }
  ]
}
Fields
compatibleRemoteAgents[]

object (RemoteAgentCompatibleWithJobs)

Output only. List of remote agents that are compatible with jobs. Compatible with jobs means that the agent is in a state to take a job.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RemoteAgentCompatibleWithJobs

Remote agents that are ready to take a job.

JSON representation 
{
  "identifier": string,
  "displayName": string,
  "availabilityStatus": enum (RemoteAgentAvailabilityJobStatus)
}
Fields
identifier

string

Output only. Unique GUID Identifier of the remote agent
displayName

string

Output only. The display name of the remote agent.
availabilityStatus

enum (RemoteAgentAvailabilityJobStatus)

Output only. The remote agent's jobs availability status.

RemoteAgentAvailabilityJobStatus

The remote agent jobs availability status on specific integration

Enums
REMOTE_AGENT_AVAILABILITY_JOB_STATUS_UNSPECIFIED Remote agent availability job status is unspecified.
AVAILABLE The remote agent is available for the job.
MISCONFIGURATION_ERROR The remote agent is not available for the job due to misconfiguration.
CONNECTION_ERROR The remote agent is not available for the job due to connection error.
UNSUPPORTED_VERSION The remote agent is not available for the job due to unsupported version.