com.oracle.bmc.dataintegration.requests.ListSchedulesRequest 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, 2023, 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 ListSchedulesRequest.
*/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200430")
public class ListSchedulesRequest extends com.oracle.bmc.requests.BmcRequest {
/**
* The workspace ID.
*/
private String workspaceId;
/**
* The workspace ID.
*/
public String getWorkspaceId() {
return workspaceId;
}
/**
* The application key.
*/
private String applicationKey;
/**
* The application key.
*/
public String getApplicationKey() {
return applicationKey;
}
/**
* Used to filter by the key of the object.
*/
private java.util.List key;
/**
* Used to filter by the key of the object.
*/
public java.util.List getKey() {
return key;
}
/**
* Used to filter by the name of the object.
*/
private String name;
/**
* Used to filter by the name of the object.
*/
public String getName() {
return name;
}
/**
* Used to filter by the identifier of the object.
*/
private java.util.List identifier;
/**
* Used to filter by the identifier of the object.
*/
public java.util.List getIdentifier() {
return 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;
/**
* 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
*/
public java.util.List getType() {
return type;
}
/**
* For list pagination. The value for this parameter is the {@code opc-next-page} or the {@code opc-prev-page} response header from the previous {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private String page;
/**
* For list pagination. The value for this parameter is the {@code opc-next-page} or the {@code opc-prev-page} response header from the previous {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
public String getPage() {
return page;
}
/**
* Sets the maximum number of results per page, or items to return in a paginated {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private Integer limit;
/**
* Sets the maximum number of results per page, or items to return in a paginated {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
public Integer getLimit() {
return limit;
}
/**
* 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 {@code 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 {@code query} is present (search operation and sorting order is by relevance score in descending order).
**/
public enum SortBy {
TimeCreated("TIME_CREATED"),
DisplayName("DISPLAY_NAME"),
TimeUpdated("TIME_UPDATED"),
;
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);
}
};
/**
* 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 {@code query} is present (search operation and sorting order is by relevance score in descending order).
*/
public SortBy getSortBy() {
return sortBy;
}
/**
* Specifies sort order to use, either {@code ASC} (ascending) or {@code DESC} (descending).
*/
private SortOrder sortOrder;
/**
* Specifies sort order to use, either {@code ASC} (ascending) or {@code 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 sort order to use, either {@code ASC} (ascending) or {@code DESC} (descending).
*/
public SortOrder getSortOrder() {
return sortOrder;
}
/**
* 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 Oracle-assigned identifier for the request. If
* you need to contact Oracle about a particular request,
* please provide the request ID.
*
*/
public String getOpcRequestId() {
return opcRequestId;
}
public static class Builder
implements com.oracle.bmc.requests.BmcRequest.Builder<
ListSchedulesRequest, java.lang.Void> {
private com.oracle.bmc.util.internal.Consumer
invocationCallback = null;
private com.oracle.bmc.retrier.RetryConfiguration retryConfiguration = null;
/**
* The workspace ID.
*/
private String workspaceId = null;
/**
* The workspace ID.
* @param workspaceId the value to set
* @return this builder instance
*/
public Builder workspaceId(String workspaceId) {
this.workspaceId = workspaceId;
return this;
}
/**
* The application key.
*/
private String applicationKey = null;
/**
* The application key.
* @param applicationKey the value to set
* @return this builder instance
*/
public Builder applicationKey(String applicationKey) {
this.applicationKey = applicationKey;
return this;
}
/**
* Used to filter by the key of the object.
*/
private java.util.List key = null;
/**
* Used to filter by the key of the object.
* @param key the value to set
* @return this builder instance
*/
public Builder key(java.util.List key) {
this.key = key;
return this;
}
/**
* Singular setter. Used to filter by the key of the object.
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder key(String singularValue) {
return this.key(java.util.Arrays.asList(singularValue));
}
/**
* Used to filter by the name of the object.
*/
private String name = null;
/**
* Used to filter by the name of the object.
* @param name the value to set
* @return this builder instance
*/
public Builder name(String name) {
this.name = name;
return this;
}
/**
* Used to filter by the identifier of the object.
*/
private java.util.List identifier = null;
/**
* Used to filter by the identifier of the object.
* @param identifier the value to set
* @return this builder instance
*/
public Builder identifier(java.util.List identifier) {
this.identifier = identifier;
return this;
}
/**
* Singular setter. Used to filter by the identifier of the object.
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder identifier(String singularValue) {
return this.identifier(java.util.Arrays.asList(singularValue));
}
/**
* 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 = null;
/**
* 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
* @param type the value to set
* @return this builder instance
*/
public Builder type(java.util.List type) {
this.type = type;
return this;
}
/**
* Singular setter. 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
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder type(String singularValue) {
return this.type(java.util.Arrays.asList(singularValue));
}
/**
* For list pagination. The value for this parameter is the {@code opc-next-page} or the {@code opc-prev-page} response header from the previous {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private String page = null;
/**
* For list pagination. The value for this parameter is the {@code opc-next-page} or the {@code opc-prev-page} response header from the previous {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
* @param page the value to set
* @return this builder instance
*/
public Builder page(String page) {
this.page = page;
return this;
}
/**
* Sets the maximum number of results per page, or items to return in a paginated {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
*/
private Integer limit = null;
/**
* Sets the maximum number of results per page, or items to return in a paginated {@code List} call. See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
* @param limit the value to set
* @return this builder instance
*/
public Builder limit(Integer limit) {
this.limit = limit;
return this;
}
/**
* 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 {@code query} is present (search operation and sorting order is by relevance score in descending order).
*/
private SortBy sortBy = null;
/**
* 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 {@code query} is present (search operation and sorting order is by relevance score in descending order).
* @param sortBy the value to set
* @return this builder instance
*/
public Builder sortBy(SortBy sortBy) {
this.sortBy = sortBy;
return this;
}
/**
* Specifies sort order to use, either {@code ASC} (ascending) or {@code DESC} (descending).
*/
private SortOrder sortOrder = null;
/**
* Specifies sort order to use, either {@code ASC} (ascending) or {@code DESC} (descending).
* @param sortOrder the value to set
* @return this builder instance
*/
public Builder sortOrder(SortOrder sortOrder) {
this.sortOrder = sortOrder;
return this;
}
/**
* 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 = null;
/**
* Unique Oracle-assigned identifier for the request. If
* you need to contact Oracle about a particular request,
* please provide the request ID.
*
* @param opcRequestId the value to set
* @return this builder instance
*/
public Builder opcRequestId(String opcRequestId) {
this.opcRequestId = opcRequestId;
return this;
}
/**
* 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(ListSchedulesRequest o) {
workspaceId(o.getWorkspaceId());
applicationKey(o.getApplicationKey());
key(o.getKey());
name(o.getName());
identifier(o.getIdentifier());
type(o.getType());
page(o.getPage());
limit(o.getLimit());
sortBy(o.getSortBy());
sortOrder(o.getSortOrder());
opcRequestId(o.getOpcRequestId());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of ListSchedulesRequest 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 ListSchedulesRequest
*/
public ListSchedulesRequest build() {
ListSchedulesRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
/**
* Build the instance of ListSchedulesRequest as configured by this builder
*
* Note that this method does not take calls to {@link Builder#invocationCallback(com.oracle.bmc.util.internal.Consumer)} into account,
* while the method {@link Builder#build} does
*
* @return instance of ListSchedulesRequest
*/
public ListSchedulesRequest buildWithoutInvocationCallback() {
ListSchedulesRequest request = new ListSchedulesRequest();
request.workspaceId = workspaceId;
request.applicationKey = applicationKey;
request.key = key;
request.name = name;
request.identifier = identifier;
request.type = type;
request.page = page;
request.limit = limit;
request.sortBy = sortBy;
request.sortOrder = sortOrder;
request.opcRequestId = opcRequestId;
return request;
// new ListSchedulesRequest(workspaceId, applicationKey, key, name, identifier, type, page, limit, sortBy, sortOrder, opcRequestId);
}
}
/**
* Return an instance of {@link Builder} that allows you to modify request properties.
* @return instance of {@link Builder} that allows you to modify request properties.
*/
public Builder toBuilder() {
return new Builder()
.workspaceId(workspaceId)
.applicationKey(applicationKey)
.key(key)
.name(name)
.identifier(identifier)
.type(type)
.page(page)
.limit(limit)
.sortBy(sortBy)
.sortOrder(sortOrder)
.opcRequestId(opcRequestId);
}
/**
* Return a new builder for this request object.
* @return builder for the request object
*/
public static Builder builder() {
return new Builder();
}
@Override
public String toString() {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("(");
sb.append("super=").append(super.toString());
sb.append(",workspaceId=").append(String.valueOf(this.workspaceId));
sb.append(",applicationKey=").append(String.valueOf(this.applicationKey));
sb.append(",key=").append(String.valueOf(this.key));
sb.append(",name=").append(String.valueOf(this.name));
sb.append(",identifier=").append(String.valueOf(this.identifier));
sb.append(",type=").append(String.valueOf(this.type));
sb.append(",page=").append(String.valueOf(this.page));
sb.append(",limit=").append(String.valueOf(this.limit));
sb.append(",sortBy=").append(String.valueOf(this.sortBy));
sb.append(",sortOrder=").append(String.valueOf(this.sortOrder));
sb.append(",opcRequestId=").append(String.valueOf(this.opcRequestId));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof ListSchedulesRequest)) {
return false;
}
ListSchedulesRequest other = (ListSchedulesRequest) o;
return super.equals(o)
&& java.util.Objects.equals(this.workspaceId, other.workspaceId)
&& java.util.Objects.equals(this.applicationKey, other.applicationKey)
&& java.util.Objects.equals(this.key, other.key)
&& java.util.Objects.equals(this.name, other.name)
&& java.util.Objects.equals(this.identifier, other.identifier)
&& java.util.Objects.equals(this.type, other.type)
&& java.util.Objects.equals(this.page, other.page)
&& java.util.Objects.equals(this.limit, other.limit)
&& java.util.Objects.equals(this.sortBy, other.sortBy)
&& java.util.Objects.equals(this.sortOrder, other.sortOrder)
&& java.util.Objects.equals(this.opcRequestId, other.opcRequestId);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
result = (result * PRIME) + (this.workspaceId == null ? 43 : this.workspaceId.hashCode());
result =
(result * PRIME)
+ (this.applicationKey == null ? 43 : this.applicationKey.hashCode());
result = (result * PRIME) + (this.key == null ? 43 : this.key.hashCode());
result = (result * PRIME) + (this.name == null ? 43 : this.name.hashCode());
result = (result * PRIME) + (this.identifier == null ? 43 : this.identifier.hashCode());
result = (result * PRIME) + (this.type == null ? 43 : this.type.hashCode());
result = (result * PRIME) + (this.page == null ? 43 : this.page.hashCode());
result = (result * PRIME) + (this.limit == null ? 43 : this.limit.hashCode());
result = (result * PRIME) + (this.sortBy == null ? 43 : this.sortBy.hashCode());
result = (result * PRIME) + (this.sortOrder == null ? 43 : this.sortOrder.hashCode());
result = (result * PRIME) + (this.opcRequestId == null ? 43 : this.opcRequestId.hashCode());
return result;
}
}