A list of all methods in the QueuesService
service. Click on the method name to view detailed information about that method.
Methods | Description |
---|---|
listQueues | Gets the list of queues in the given project. |
createQueue | Creates a new queue in the given project. |
getQueue | Gets an existing queue in the given project. |
updateQueue | Updates an existing queue in the given project. |
deleteQueue | Deletes an existing queue in the given project. |
listQueueJobs | Gets the list of jobs in a queue |
createQueueJob | Creates a new job |
getQueueJob | Gets a job in a queue |
deleteQueueJob | Cancels a job in a queue |
Gets the list of queues in the given project.
- HTTP Method:
GET
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
Return Type
QueueList
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.QueueList;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
QueueList response = saladCloudSdk.queuesService.listQueues(
"xtp82b9jzwqov1insghigvfq0donadhrrdqx-2redu46g7e",
"xk27gbnpmwk5xor49bk4ujk7"
);
System.out.println(response);
}
}
Creates a new queue in the given project.
- HTTP Method:
POST
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
createQueue | CreateQueue | ✅ | Request Body |
Return Type
Queue
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.CreateQueue;
import com.salad.cloud.sdk.models.Queue;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
CreateQueue createQueue = CreateQueue
.builder()
.name("ho4d79h7bg0vpngqc8hz5pxjwi")
.displayName("IWPKHVWPTc")
.description("aliqua id nostrud")
.build();
Queue response = saladCloudSdk.queuesService.createQueue(
"xtp82b9jzwqov1insghigvfq0donadhrrdqx-2redu46g7e",
"xk27gbnpmwk5xor49bk4ujk7",
createQueue
);
System.out.println(response);
}
}
Gets an existing queue in the given project.
- HTTP Method:
GET
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
Return Type
Queue
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.Queue;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
Queue response = saladCloudSdk.queuesService.getQueue(
"bb5wprcvb9628akhug9lnd2",
"bw-4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsy",
"wilo12xl52y9c178cmdya6ykpby-hunb0b6s7s2l"
);
System.out.println(response);
}
}
Updates an existing queue in the given project.
- HTTP Method:
PATCH
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
updateQueue | UpdateQueue | ✅ | Request Body |
Return Type
Queue
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.Queue;
import com.salad.cloud.sdk.models.UpdateQueue;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
UpdateQueue updateQueue = UpdateQueue.builder().displayName("O5Yf2").description("cupidatat").build();
Queue response = saladCloudSdk.queuesService.updateQueue(
"bb5wprcvb9628akhug9lnd2",
"bw-4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsy",
"wilo12xl52y9c178cmdya6ykpby-hunb0b6s7s2l",
updateQueue
);
System.out.println(response);
}
}
Deletes an existing queue in the given project.
- HTTP Method:
DELETE
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
saladCloudSdk.queuesService.deleteQueue(
"bb5wprcvb9628akhug9lnd2",
"bw-4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsy",
"wilo12xl52y9c178cmdya6ykpby-hunb0b6s7s2l"
);
}
}
Gets the list of jobs in a queue
- HTTP Method:
GET
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
requestParameters | ListQueueJobsParameters | ❌ | Request Parameters Object |
Return Type
QueueJobList
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.ListQueueJobsParameters;
import com.salad.cloud.sdk.models.QueueJobList;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
ListQueueJobsParameters requestParameters = ListQueueJobsParameters
.builder()
.page(706148771L)
.pageSize(45L)
.build();
QueueJobList response = saladCloudSdk.queuesService.listQueueJobs(
"wcaz2jbu5pfmpygxffsf4bh4e6",
"dzh9lv6afpamv8cx0x6",
"s9f4ikmr0j6c3n18n4djttkqmgzb46dd5wogzrfe2pq12s2",
requestParameters
);
System.out.println(response);
}
}
Creates a new job
- HTTP Method:
POST
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
createQueueJob | CreateQueueJob | ✅ | Request Body |
Return Type
QueueJob
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.CreateQueueJob;
import com.salad.cloud.sdk.models.QueueJob;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
CreateQueueJob createQueueJob = CreateQueueJob
.builder()
.input(new Object())
.metadata(new Object())
.webhook("webhook")
.build();
QueueJob response = saladCloudSdk.queuesService.createQueueJob(
"wcaz2jbu5pfmpygxffsf4bh4e6",
"dzh9lv6afpamv8cx0x6",
"s9f4ikmr0j6c3n18n4djttkqmgzb46dd5wogzrfe2pq12s2",
createQueueJob
);
System.out.println(response);
}
}
Gets a job in a queue
- HTTP Method:
GET
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
queueJobId | String | ✅ | The job identifier. This is automatically generated and assigned when the job is created. |
Return Type
QueueJob
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
import com.salad.cloud.sdk.models.QueueJob;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
QueueJob response = saladCloudSdk.queuesService.getQueueJob("zm-jv", "tq26", "je5dpzbgsk8gvp", "queue_job_id");
System.out.println(response);
}
}
Cancels a job in a queue
- HTTP Method:
DELETE
- Endpoint:
/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}
Parameters
Name | Type | Required | Description |
---|---|---|---|
organizationName | String | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. |
projectName | String | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. |
queueName | String | ✅ | The queue name. |
queueJobId | String | ✅ | The job identifier. This is automatically generated and assigned when the job is created. |
Example Usage Code Snippet
import com.salad.cloud.sdk.SaladCloudSdk;
import com.salad.cloud.sdk.config.ApiKeyAuthConfig;
import com.salad.cloud.sdk.config.SaladCloudSdkConfig;
public class Main {
public static void main(String[] args) {
SaladCloudSdkConfig config = SaladCloudSdkConfig
.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);
saladCloudSdk.queuesService.deleteQueueJob("zm-jv", "tq26", "je5dpzbgsk8gvp", "queue_job_id");
}
}