com.oracle.bmc.dataintegration.requests.ListTasksRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-dataintegration Show documentation
Show all versions of oci-java-sdk-dataintegration Show documentation
This project contains the SDK used for Oracle Cloud Infrastructure Data Integration
/**
* Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.dataintegration.requests;
import com.oracle.bmc.dataintegration.model.*;
/**
* Example: Click here to see how to use ListTasksRequest.
*/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200430")
@lombok.Builder(
builderClassName = "Builder",
buildMethodName = "buildWithoutInvocationCallback",
toBuilder = true
)
@lombok.ToString(callSuper = true)
@lombok.EqualsAndHashCode(callSuper = true)
@lombok.Getter
public class ListTasksRequest extends com.oracle.bmc.requests.BmcRequest {
/**
* The workspace ID.
*/
private String workspaceId;
/**
* Unique Oracle-assigned identifier for the request. If
* you need to contact Oracle about a particular request,
* please provide the request ID.
*
*/
private String opcRequestId;
/**
* Unique key of the folder.
*/
private String folderId;
/**
* Specifies the fields to get for an object.
*/
private java.util.List fields;
/**
* Used to filter by the name of the object.
*/
private String name;
/**
* Used to filter by the key of the object.
*/
private java.util.List key;
/**
* Used to filter by the identifier of the object.
*/
private java.util.List identifier;
/**
* Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
Examples:
- ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
- ?type=DATA_LOADER_TASK returns all objects of type data loader task
- ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/
private java.util.List type;
/**
* Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private Integer limit;
/**
* For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private String page;
/**
* Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
*/
private SortOrder sortOrder;
/**
* Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
**/
public enum SortOrder {
Asc("ASC"),
Desc("DESC"),
;
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (SortOrder v : SortOrder.values()) {
map.put(v.getValue(), v);
}
}
SortOrder(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static SortOrder create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
throw new IllegalArgumentException("Invalid SortOrder: " + key);
}
};
/**
* Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order).
*/
private SortBy sortBy;
/**
* Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order).
**/
public enum SortBy {
TimeCreated("TIME_CREATED"),
DisplayName("DISPLAY_NAME"),
;
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (SortBy v : SortBy.values()) {
map.put(v.getValue(), v);
}
}
SortBy(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static SortBy create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
throw new IllegalArgumentException("Invalid SortBy: " + key);
}
};
public static class Builder
implements com.oracle.bmc.requests.BmcRequest.Builder<
ListTasksRequest, java.lang.Void> {
private com.oracle.bmc.util.internal.Consumer
invocationCallback = null;
private com.oracle.bmc.retrier.RetryConfiguration retryConfiguration = null;
/**
* Set the invocation callback for the request to be built.
* @param invocationCallback the invocation callback to be set for the request
* @return this builder instance
*/
public Builder invocationCallback(
com.oracle.bmc.util.internal.Consumer
invocationCallback) {
this.invocationCallback = invocationCallback;
return this;
}
/**
* Set the retry configuration for the request to be built.
* @param retryConfiguration the retry configuration to be used for the request
* @return this builder instance
*/
public Builder retryConfiguration(
com.oracle.bmc.retrier.RetryConfiguration retryConfiguration) {
this.retryConfiguration = retryConfiguration;
return this;
}
/**
* Copy method to populate the builder with values from the given instance.
* @return this builder instance
*/
public Builder copy(ListTasksRequest o) {
workspaceId(o.getWorkspaceId());
opcRequestId(o.getOpcRequestId());
folderId(o.getFolderId());
fields(o.getFields());
name(o.getName());
key(o.getKey());
identifier(o.getIdentifier());
type(o.getType());
limit(o.getLimit());
page(o.getPage());
sortOrder(o.getSortOrder());
sortBy(o.getSortBy());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of ListTasksRequest as configured by this builder
*
* Note that this method takes calls to {@link Builder#invocationCallback(com.oracle.bmc.util.internal.Consumer)} into account,
* while the method {@link Builder#buildWithoutInvocationCallback} does not.
*
* This is the preferred method to build an instance.
*
* @return instance of ListTasksRequest
*/
public ListTasksRequest build() {
ListTasksRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
}
}