com.oracle.bmc.dataintegration.requests.ListWorkspacesRequest Maven / Gradle / Ivy
Show all versions of oci-java-sdk-dataintegration Show documentation
/**
* Copyright (c) 2016, 2022, 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 ListWorkspacesRequest.
*/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200430")
public class ListWorkspacesRequest extends com.oracle.bmc.requests.BmcRequest {
/** The OCID of the compartment containing the resources you want to list. */
private String compartmentId;
/** The OCID of the compartment containing the resources you want to list. */
public String getCompartmentId() {
return compartmentId;
}
/** 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* The lifecycle state of a resource. When specified, the operation only returns resources that
* match the given lifecycle state. When not specified, all lifecycle states are processed as a
* match.
*/
private com.oracle.bmc.dataintegration.model.Workspace.LifecycleState lifecycleState;
/**
* The lifecycle state of a resource. When specified, the operation only returns resources that
* match the given lifecycle state. When not specified, all lifecycle states are processed as a
* match.
*/
public com.oracle.bmc.dataintegration.model.Workspace.LifecycleState getLifecycleState() {
return lifecycleState;
}
/** 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 implements com.oracle.bmc.http.internal.BmcEnum {
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;
}
/**
* 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 implements com.oracle.bmc.http.internal.BmcEnum {
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;
}
/**
* 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<
ListWorkspacesRequest, java.lang.Void> {
private com.oracle.bmc.http.client.RequestInterceptor invocationCallback = null;
private com.oracle.bmc.retrier.RetryConfiguration retryConfiguration = null;
/** The OCID of the compartment containing the resources you want to list. */
private String compartmentId = null;
/**
* The OCID of the compartment containing the resources you want to list.
*
* @param compartmentId the value to set
* @return this builder instance
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
return this;
}
/** 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* The lifecycle state of a resource. When specified, the operation only returns resources
* that match the given lifecycle state. When not specified, all lifecycle states are
* processed as a match.
*/
private com.oracle.bmc.dataintegration.model.Workspace.LifecycleState lifecycleState = null;
/**
* The lifecycle state of a resource. When specified, the operation only returns resources
* that match the given lifecycle state. When not specified, all lifecycle states are
* processed as a match.
*
* @param lifecycleState the value to set
* @return this builder instance
*/
public Builder lifecycleState(
com.oracle.bmc.dataintegration.model.Workspace.LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
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;
}
/**
* 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;
}
/**
* 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.http.client.RequestInterceptor 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(ListWorkspacesRequest o) {
compartmentId(o.getCompartmentId());
name(o.getName());
limit(o.getLimit());
page(o.getPage());
lifecycleState(o.getLifecycleState());
sortOrder(o.getSortOrder());
sortBy(o.getSortBy());
opcRequestId(o.getOpcRequestId());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of ListWorkspacesRequest as configured by this builder
*
* Note that this method takes calls to {@link
* Builder#invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)} into account,
* while the method {@link Builder#buildWithoutInvocationCallback} does not.
*
*
This is the preferred method to build an instance.
*
* @return instance of ListWorkspacesRequest
*/
public ListWorkspacesRequest build() {
ListWorkspacesRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
/**
* Build the instance of ListWorkspacesRequest as configured by this builder
*
*
Note that this method does not take calls to {@link
* Builder#invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)} into account,
* while the method {@link Builder#build} does
*
* @return instance of ListWorkspacesRequest
*/
public ListWorkspacesRequest buildWithoutInvocationCallback() {
ListWorkspacesRequest request = new ListWorkspacesRequest();
request.compartmentId = compartmentId;
request.name = name;
request.limit = limit;
request.page = page;
request.lifecycleState = lifecycleState;
request.sortOrder = sortOrder;
request.sortBy = sortBy;
request.opcRequestId = opcRequestId;
return request;
// new ListWorkspacesRequest(compartmentId, name, limit, page, lifecycleState,
// sortOrder, sortBy, 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()
.compartmentId(compartmentId)
.name(name)
.limit(limit)
.page(page)
.lifecycleState(lifecycleState)
.sortOrder(sortOrder)
.sortBy(sortBy)
.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(",compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(",name=").append(String.valueOf(this.name));
sb.append(",limit=").append(String.valueOf(this.limit));
sb.append(",page=").append(String.valueOf(this.page));
sb.append(",lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(",sortOrder=").append(String.valueOf(this.sortOrder));
sb.append(",sortBy=").append(String.valueOf(this.sortBy));
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 ListWorkspacesRequest)) {
return false;
}
ListWorkspacesRequest other = (ListWorkspacesRequest) o;
return super.equals(o)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.name, other.name)
&& java.util.Objects.equals(this.limit, other.limit)
&& java.util.Objects.equals(this.page, other.page)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& java.util.Objects.equals(this.sortOrder, other.sortOrder)
&& java.util.Objects.equals(this.sortBy, other.sortBy)
&& java.util.Objects.equals(this.opcRequestId, other.opcRequestId);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result = (result * PRIME) + (this.name == null ? 43 : this.name.hashCode());
result = (result * PRIME) + (this.limit == null ? 43 : this.limit.hashCode());
result = (result * PRIME) + (this.page == null ? 43 : this.page.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result = (result * PRIME) + (this.sortOrder == null ? 43 : this.sortOrder.hashCode());
result = (result * PRIME) + (this.sortBy == null ? 43 : this.sortBy.hashCode());
result = (result * PRIME) + (this.opcRequestId == null ? 43 : this.opcRequestId.hashCode());
return result;
}
}