com.oracle.bmc.dataintegration.requests.ListDataEntitiesRequest 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 ListDataEntitiesRequest.
*/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200430")
public class ListDataEntitiesRequest extends com.oracle.bmc.requests.BmcRequest {
/**
* The workspace ID.
*/
private String workspaceId;
/**
* The workspace ID.
*/
public String getWorkspaceId() {
return workspaceId;
}
/**
* The connection key.
*/
private String connectionKey;
/**
* The connection key.
*/
public String getConnectionKey() {
return connectionKey;
}
/**
* The schema resource name used for retrieving schemas.
*/
private String schemaResourceName;
/**
* The schema resource name used for retrieving schemas.
*/
public String getSchemaResourceName() {
return schemaResourceName;
}
/**
* 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;
}
/**
* 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;
}
/**
* Type of the object to filter the results with.
*/
private String type;
/**
* Type of the object to filter the results with.
*/
public String getType() {
return type;
}
/**
* 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 fields to get for an object.
*/
private java.util.List fields;
/**
* Specifies the fields to get for an object.
*/
public java.util.List getFields() {
return fields;
}
/**
* 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;
}
/**
* Used to filter by the name of the object.
*/
private java.util.List nameList;
/**
* Used to filter by the name of the object.
*/
public java.util.List getNameList() {
return nameList;
}
/**
* This parameter can be used to specify whether entity search type is pattern search or not.
*/
private Boolean isPattern;
/**
* This parameter can be used to specify whether entity search type is pattern search or not.
*/
public Boolean getIsPattern() {
return isPattern;
}
/**
* Artifact type which needs to be listed while listing Artifacts.
*/
private java.util.List includeTypes;
/**
* Artifact type which needs to be listed while listing Artifacts.
*/
public java.util.List getIncludeTypes() {
return includeTypes;
}
public static class Builder
implements com.oracle.bmc.requests.BmcRequest.Builder<
ListDataEntitiesRequest, 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 connection key.
*/
private String connectionKey = null;
/**
* The connection key.
* @param connectionKey the value to set
* @return this builder instance
*/
public Builder connectionKey(String connectionKey) {
this.connectionKey = connectionKey;
return this;
}
/**
* The schema resource name used for retrieving schemas.
*/
private String schemaResourceName = null;
/**
* The schema resource name used for retrieving schemas.
* @param schemaResourceName the value to set
* @return this builder instance
*/
public Builder schemaResourceName(String schemaResourceName) {
this.schemaResourceName = schemaResourceName;
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;
}
/**
* 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;
}
/**
* Type of the object to filter the results with.
*/
private String type = null;
/**
* Type of the object to filter the results with.
* @param type the value to set
* @return this builder instance
*/
public Builder type(String type) {
this.type = type;
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 fields to get for an object.
*/
private java.util.List fields = null;
/**
* Specifies the fields to get for an object.
* @param fields the value to set
* @return this builder instance
*/
public Builder fields(java.util.List fields) {
this.fields = fields;
return this;
}
/**
* Singular setter. Specifies the fields to get for an object.
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder fields(String singularValue) {
return this.fields(java.util.Arrays.asList(singularValue));
}
/**
* 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;
}
/**
* Used to filter by the name of the object.
*/
private java.util.List nameList = null;
/**
* Used to filter by the name of the object.
* @param nameList the value to set
* @return this builder instance
*/
public Builder nameList(java.util.List nameList) {
this.nameList = nameList;
return this;
}
/**
* Singular setter. Used to filter by the name of the object.
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder nameList(String singularValue) {
return this.nameList(java.util.Arrays.asList(singularValue));
}
/**
* This parameter can be used to specify whether entity search type is pattern search or not.
*/
private Boolean isPattern = null;
/**
* This parameter can be used to specify whether entity search type is pattern search or not.
* @param isPattern the value to set
* @return this builder instance
*/
public Builder isPattern(Boolean isPattern) {
this.isPattern = isPattern;
return this;
}
/**
* Artifact type which needs to be listed while listing Artifacts.
*/
private java.util.List includeTypes = null;
/**
* Artifact type which needs to be listed while listing Artifacts.
* @param includeTypes the value to set
* @return this builder instance
*/
public Builder includeTypes(java.util.List includeTypes) {
this.includeTypes = includeTypes;
return this;
}
/**
* Singular setter. Artifact type which needs to be listed while listing Artifacts.
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder includeTypes(String singularValue) {
return this.includeTypes(java.util.Arrays.asList(singularValue));
}
/**
* 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(ListDataEntitiesRequest o) {
workspaceId(o.getWorkspaceId());
connectionKey(o.getConnectionKey());
schemaResourceName(o.getSchemaResourceName());
name(o.getName());
page(o.getPage());
type(o.getType());
limit(o.getLimit());
fields(o.getFields());
sortBy(o.getSortBy());
sortOrder(o.getSortOrder());
opcRequestId(o.getOpcRequestId());
nameList(o.getNameList());
isPattern(o.getIsPattern());
includeTypes(o.getIncludeTypes());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of ListDataEntitiesRequest 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 ListDataEntitiesRequest
*/
public ListDataEntitiesRequest build() {
ListDataEntitiesRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
/**
* Build the instance of ListDataEntitiesRequest 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 ListDataEntitiesRequest
*/
public ListDataEntitiesRequest buildWithoutInvocationCallback() {
ListDataEntitiesRequest request = new ListDataEntitiesRequest();
request.workspaceId = workspaceId;
request.connectionKey = connectionKey;
request.schemaResourceName = schemaResourceName;
request.name = name;
request.page = page;
request.type = type;
request.limit = limit;
request.fields = fields;
request.sortBy = sortBy;
request.sortOrder = sortOrder;
request.opcRequestId = opcRequestId;
request.nameList = nameList;
request.isPattern = isPattern;
request.includeTypes = includeTypes;
return request;
// new ListDataEntitiesRequest(workspaceId, connectionKey, schemaResourceName, name, page, type, limit, fields, sortBy, sortOrder, opcRequestId, nameList, isPattern, includeTypes);
}
}
/**
* 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)
.connectionKey(connectionKey)
.schemaResourceName(schemaResourceName)
.name(name)
.page(page)
.type(type)
.limit(limit)
.fields(fields)
.sortBy(sortBy)
.sortOrder(sortOrder)
.opcRequestId(opcRequestId)
.nameList(nameList)
.isPattern(isPattern)
.includeTypes(includeTypes);
}
/**
* 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(",connectionKey=").append(String.valueOf(this.connectionKey));
sb.append(",schemaResourceName=").append(String.valueOf(this.schemaResourceName));
sb.append(",name=").append(String.valueOf(this.name));
sb.append(",page=").append(String.valueOf(this.page));
sb.append(",type=").append(String.valueOf(this.type));
sb.append(",limit=").append(String.valueOf(this.limit));
sb.append(",fields=").append(String.valueOf(this.fields));
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(",nameList=").append(String.valueOf(this.nameList));
sb.append(",isPattern=").append(String.valueOf(this.isPattern));
sb.append(",includeTypes=").append(String.valueOf(this.includeTypes));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof ListDataEntitiesRequest)) {
return false;
}
ListDataEntitiesRequest other = (ListDataEntitiesRequest) o;
return super.equals(o)
&& java.util.Objects.equals(this.workspaceId, other.workspaceId)
&& java.util.Objects.equals(this.connectionKey, other.connectionKey)
&& java.util.Objects.equals(this.schemaResourceName, other.schemaResourceName)
&& java.util.Objects.equals(this.name, other.name)
&& java.util.Objects.equals(this.page, other.page)
&& java.util.Objects.equals(this.type, other.type)
&& java.util.Objects.equals(this.limit, other.limit)
&& java.util.Objects.equals(this.fields, other.fields)
&& java.util.Objects.equals(this.sortBy, other.sortBy)
&& java.util.Objects.equals(this.sortOrder, other.sortOrder)
&& java.util.Objects.equals(this.opcRequestId, other.opcRequestId)
&& java.util.Objects.equals(this.nameList, other.nameList)
&& java.util.Objects.equals(this.isPattern, other.isPattern)
&& java.util.Objects.equals(this.includeTypes, other.includeTypes);
}
@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.connectionKey == null ? 43 : this.connectionKey.hashCode());
result =
(result * PRIME)
+ (this.schemaResourceName == null
? 43
: this.schemaResourceName.hashCode());
result = (result * PRIME) + (this.name == null ? 43 : this.name.hashCode());
result = (result * PRIME) + (this.page == null ? 43 : this.page.hashCode());
result = (result * PRIME) + (this.type == null ? 43 : this.type.hashCode());
result = (result * PRIME) + (this.limit == null ? 43 : this.limit.hashCode());
result = (result * PRIME) + (this.fields == null ? 43 : this.fields.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());
result = (result * PRIME) + (this.nameList == null ? 43 : this.nameList.hashCode());
result = (result * PRIME) + (this.isPattern == null ? 43 : this.isPattern.hashCode());
result = (result * PRIME) + (this.includeTypes == null ? 43 : this.includeTypes.hashCode());
return result;
}
}