com.oracle.bmc.cloudguard.requests.RequestSummarizedResponderExecutionsRequest Maven / Gradle / Ivy
/**
* Copyright (c) 2016, 2024, 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.cloudguard.requests;
import com.oracle.bmc.cloudguard.model.*;
/**
* Example: Click here to see how to use
* RequestSummarizedResponderExecutionsRequest.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200131")
public class RequestSummarizedResponderExecutionsRequest
extends com.oracle.bmc.requests.BmcRequest {
/** The possible attributes based on which the responder executions can be distinguished. */
private java.util.List
responderExecutionsDimensions;
/** The possible attributes based on which the responder executions can be distinguished. */
public java.util.List
getResponderExecutionsDimensions() {
return responderExecutionsDimensions;
}
/** The OCID of the compartment in which to list resources. */
private String compartmentId;
/** The OCID of the compartment in which to list resources. */
public String getCompartmentId() {
return compartmentId;
}
/**
* The possible filters for responder type dimension to distinguish responder executions. If no
* values are passed, the metric for responder executions of all responder types are returned.
*/
private java.util.List responderTypeFilter;
/**
* The possible filters for responder type dimension to distinguish responder executions. If no
* values are passed, the metric for responder executions of all responder types are returned.
*/
public java.util.List getResponderTypeFilter() {
return responderTypeFilter;
}
/**
* The possible filters for responder type dimension to distinguish responder executions. If no
* values are passed, the metric for responder executions of all status are returned.
*/
private java.util.List
responderExecutionStatusFilter;
/**
* The possible filters for responder type dimension to distinguish responder executions. If no
* values are passed, the metric for responder executions of all status are returned.
*/
public java.util.List
getResponderExecutionStatusFilter() {
return responderExecutionStatusFilter;
}
/**
* Default is false. When set to true, the hierarchy of compartments is traversed and all
* compartments and subcompartments in the tenancy are returned depending on the setting of
* {@code accessLevel}.
*/
private Boolean compartmentIdInSubtree;
/**
* Default is false. When set to true, the hierarchy of compartments is traversed and all
* compartments and subcompartments in the tenancy are returned depending on the setting of
* {@code accessLevel}.
*/
public Boolean getCompartmentIdInSubtree() {
return compartmentIdInSubtree;
}
/**
* Valid values are {@code RESTRICTED} and {@code ACCESSIBLE}. Default is {@code RESTRICTED}.
* Setting this to {@code ACCESSIBLE} returns only those compartments for which the user has
* INSPECT permissions directly or indirectly (permissions can be on a resource in a
* subcompartment). When set to {@code RESTRICTED} permissions are checked and no partial
* results are displayed.
*/
private AccessLevel accessLevel;
/**
* Valid values are {@code RESTRICTED} and {@code ACCESSIBLE}. Default is {@code RESTRICTED}.
* Setting this to {@code ACCESSIBLE} returns only those compartments for which the user has
* INSPECT permissions directly or indirectly (permissions can be on a resource in a
* subcompartment). When set to {@code RESTRICTED} permissions are checked and no partial
* results are displayed.
*/
public enum AccessLevel implements com.oracle.bmc.http.internal.BmcEnum {
Restricted("RESTRICTED"),
Accessible("ACCESSIBLE"),
;
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (AccessLevel v : AccessLevel.values()) {
map.put(v.getValue(), v);
}
}
AccessLevel(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static AccessLevel create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
throw new IllegalArgumentException("Invalid AccessLevel: " + key);
}
};
/**
* Valid values are {@code RESTRICTED} and {@code ACCESSIBLE}. Default is {@code RESTRICTED}.
* Setting this to {@code ACCESSIBLE} returns only those compartments for which the user has
* INSPECT permissions directly or indirectly (permissions can be on a resource in a
* subcompartment). When set to {@code RESTRICTED} permissions are checked and no partial
* results are displayed.
*/
public AccessLevel getAccessLevel() {
return accessLevel;
}
/** The maximum number of items to return */
private Integer limit;
/** The maximum number of items to return */
public Integer getLimit() {
return limit;
}
/**
* The page token representing the page at which to start retrieving results. This is usually
* retrieved from a previous list call.
*/
private String page;
/**
* The page token representing the page at which to start retrieving results. This is usually
* retrieved from a previous list call.
*/
public String getPage() {
return page;
}
/** The client request ID for tracing. */
private String opcRequestId;
/** The client request ID for tracing. */
public String getOpcRequestId() {
return opcRequestId;
}
public static class Builder
implements com.oracle.bmc.requests.BmcRequest.Builder<
RequestSummarizedResponderExecutionsRequest, java.lang.Void> {
private com.oracle.bmc.http.client.RequestInterceptor invocationCallback = null;
private com.oracle.bmc.retrier.RetryConfiguration retryConfiguration = null;
/** The possible attributes based on which the responder executions can be distinguished. */
private java.util.List
responderExecutionsDimensions = null;
/**
* The possible attributes based on which the responder executions can be distinguished.
*
* @param responderExecutionsDimensions the value to set
* @return this builder instance
*/
public Builder responderExecutionsDimensions(
java.util.List
responderExecutionsDimensions) {
this.responderExecutionsDimensions = responderExecutionsDimensions;
return this;
}
/**
* Singular setter. The possible attributes based on which the responder executions can be
* distinguished.
*
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder responderExecutionsDimensions(ResponderDimension singularValue) {
return this.responderExecutionsDimensions(java.util.Arrays.asList(singularValue));
}
/** The OCID of the compartment in which to list resources. */
private String compartmentId = null;
/**
* The OCID of the compartment in which to list resources.
*
* @param compartmentId the value to set
* @return this builder instance
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
return this;
}
/**
* The possible filters for responder type dimension to distinguish responder executions. If
* no values are passed, the metric for responder executions of all responder types are
* returned.
*/
private java.util.List responderTypeFilter =
null;
/**
* The possible filters for responder type dimension to distinguish responder executions. If
* no values are passed, the metric for responder executions of all responder types are
* returned.
*
* @param responderTypeFilter the value to set
* @return this builder instance
*/
public Builder responderTypeFilter(
java.util.List responderTypeFilter) {
this.responderTypeFilter = responderTypeFilter;
return this;
}
/**
* Singular setter. The possible filters for responder type dimension to distinguish
* responder executions. If no values are passed, the metric for responder executions of all
* responder types are returned.
*
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder responderTypeFilter(ResponderType singularValue) {
return this.responderTypeFilter(java.util.Arrays.asList(singularValue));
}
/**
* The possible filters for responder type dimension to distinguish responder executions. If
* no values are passed, the metric for responder executions of all status are returned.
*/
private java.util.List
responderExecutionStatusFilter = null;
/**
* The possible filters for responder type dimension to distinguish responder executions. If
* no values are passed, the metric for responder executions of all status are returned.
*
* @param responderExecutionStatusFilter the value to set
* @return this builder instance
*/
public Builder responderExecutionStatusFilter(
java.util.List
responderExecutionStatusFilter) {
this.responderExecutionStatusFilter = responderExecutionStatusFilter;
return this;
}
/**
* Singular setter. The possible filters for responder type dimension to distinguish
* responder executions. If no values are passed, the metric for responder executions of all
* status are returned.
*
* @param singularValue the singular value to set
* @return this builder instance
*/
public Builder responderExecutionStatusFilter(ResponderExecutionStatus singularValue) {
return this.responderExecutionStatusFilter(java.util.Arrays.asList(singularValue));
}
/**
* Default is false. When set to true, the hierarchy of compartments is traversed and all
* compartments and subcompartments in the tenancy are returned depending on the setting of
* {@code accessLevel}.
*/
private Boolean compartmentIdInSubtree = null;
/**
* Default is false. When set to true, the hierarchy of compartments is traversed and all
* compartments and subcompartments in the tenancy are returned depending on the setting of
* {@code accessLevel}.
*
* @param compartmentIdInSubtree the value to set
* @return this builder instance
*/
public Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree) {
this.compartmentIdInSubtree = compartmentIdInSubtree;
return this;
}
/**
* Valid values are {@code RESTRICTED} and {@code ACCESSIBLE}. Default is {@code
* RESTRICTED}. Setting this to {@code ACCESSIBLE} returns only those compartments for which
* the user has INSPECT permissions directly or indirectly (permissions can be on a resource
* in a subcompartment). When set to {@code RESTRICTED} permissions are checked and no
* partial results are displayed.
*/
private AccessLevel accessLevel = null;
/**
* Valid values are {@code RESTRICTED} and {@code ACCESSIBLE}. Default is {@code
* RESTRICTED}. Setting this to {@code ACCESSIBLE} returns only those compartments for which
* the user has INSPECT permissions directly or indirectly (permissions can be on a resource
* in a subcompartment). When set to {@code RESTRICTED} permissions are checked and no
* partial results are displayed.
*
* @param accessLevel the value to set
* @return this builder instance
*/
public Builder accessLevel(AccessLevel accessLevel) {
this.accessLevel = accessLevel;
return this;
}
/** The maximum number of items to return */
private Integer limit = null;
/**
* The maximum number of items to return
*
* @param limit the value to set
* @return this builder instance
*/
public Builder limit(Integer limit) {
this.limit = limit;
return this;
}
/**
* The page token representing the page at which to start retrieving results. This is
* usually retrieved from a previous list call.
*/
private String page = null;
/**
* The page token representing the page at which to start retrieving results. This is
* usually retrieved from a previous list call.
*
* @param page the value to set
* @return this builder instance
*/
public Builder page(String page) {
this.page = page;
return this;
}
/** The client request ID for tracing. */
private String opcRequestId = null;
/**
* The client request ID for tracing.
*
* @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(RequestSummarizedResponderExecutionsRequest o) {
responderExecutionsDimensions(o.getResponderExecutionsDimensions());
compartmentId(o.getCompartmentId());
responderTypeFilter(o.getResponderTypeFilter());
responderExecutionStatusFilter(o.getResponderExecutionStatusFilter());
compartmentIdInSubtree(o.getCompartmentIdInSubtree());
accessLevel(o.getAccessLevel());
limit(o.getLimit());
page(o.getPage());
opcRequestId(o.getOpcRequestId());
invocationCallback(o.getInvocationCallback());
retryConfiguration(o.getRetryConfiguration());
return this;
}
/**
* Build the instance of RequestSummarizedResponderExecutionsRequest 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 RequestSummarizedResponderExecutionsRequest
*/
public RequestSummarizedResponderExecutionsRequest build() {
RequestSummarizedResponderExecutionsRequest request = buildWithoutInvocationCallback();
request.setInvocationCallback(invocationCallback);
request.setRetryConfiguration(retryConfiguration);
return request;
}
/**
* Build the instance of RequestSummarizedResponderExecutionsRequest 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 RequestSummarizedResponderExecutionsRequest
*/
public RequestSummarizedResponderExecutionsRequest buildWithoutInvocationCallback() {
RequestSummarizedResponderExecutionsRequest request =
new RequestSummarizedResponderExecutionsRequest();
request.responderExecutionsDimensions = responderExecutionsDimensions;
request.compartmentId = compartmentId;
request.responderTypeFilter = responderTypeFilter;
request.responderExecutionStatusFilter = responderExecutionStatusFilter;
request.compartmentIdInSubtree = compartmentIdInSubtree;
request.accessLevel = accessLevel;
request.limit = limit;
request.page = page;
request.opcRequestId = opcRequestId;
return request;
// new RequestSummarizedResponderExecutionsRequest(responderExecutionsDimensions,
// compartmentId, responderTypeFilter, responderExecutionStatusFilter,
// compartmentIdInSubtree, accessLevel, limit, page, 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()
.responderExecutionsDimensions(responderExecutionsDimensions)
.compartmentId(compartmentId)
.responderTypeFilter(responderTypeFilter)
.responderExecutionStatusFilter(responderExecutionStatusFilter)
.compartmentIdInSubtree(compartmentIdInSubtree)
.accessLevel(accessLevel)
.limit(limit)
.page(page)
.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(",responderExecutionsDimensions=")
.append(String.valueOf(this.responderExecutionsDimensions));
sb.append(",compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(",responderTypeFilter=").append(String.valueOf(this.responderTypeFilter));
sb.append(",responderExecutionStatusFilter=")
.append(String.valueOf(this.responderExecutionStatusFilter));
sb.append(",compartmentIdInSubtree=").append(String.valueOf(this.compartmentIdInSubtree));
sb.append(",accessLevel=").append(String.valueOf(this.accessLevel));
sb.append(",limit=").append(String.valueOf(this.limit));
sb.append(",page=").append(String.valueOf(this.page));
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 RequestSummarizedResponderExecutionsRequest)) {
return false;
}
RequestSummarizedResponderExecutionsRequest other =
(RequestSummarizedResponderExecutionsRequest) o;
return super.equals(o)
&& java.util.Objects.equals(
this.responderExecutionsDimensions, other.responderExecutionsDimensions)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.responderTypeFilter, other.responderTypeFilter)
&& java.util.Objects.equals(
this.responderExecutionStatusFilter, other.responderExecutionStatusFilter)
&& java.util.Objects.equals(
this.compartmentIdInSubtree, other.compartmentIdInSubtree)
&& java.util.Objects.equals(this.accessLevel, other.accessLevel)
&& java.util.Objects.equals(this.limit, other.limit)
&& java.util.Objects.equals(this.page, other.page)
&& java.util.Objects.equals(this.opcRequestId, other.opcRequestId);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
result =
(result * PRIME)
+ (this.responderExecutionsDimensions == null
? 43
: this.responderExecutionsDimensions.hashCode());
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result =
(result * PRIME)
+ (this.responderTypeFilter == null
? 43
: this.responderTypeFilter.hashCode());
result =
(result * PRIME)
+ (this.responderExecutionStatusFilter == null
? 43
: this.responderExecutionStatusFilter.hashCode());
result =
(result * PRIME)
+ (this.compartmentIdInSubtree == null
? 43
: this.compartmentIdInSubtree.hashCode());
result = (result * PRIME) + (this.accessLevel == null ? 43 : this.accessLevel.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.opcRequestId == null ? 43 : this.opcRequestId.hashCode());
return result;
}
}