com.oracle.bmc.events.model.RuleSummary Maven / Gradle / Ivy
Show all versions of oci-java-sdk-events Show documentation
/**
* 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.events.model;
/**
* The summary details of rules for Events. For more information, see [Managing Rules for
* Events](https://docs.cloud.oracle.com/iaas/Content/Events/Task/managingrules.htm).
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #equals(Object)} methods are implemented to take the explicitly set
* fields into account. The constructor, on the other hand, does not take the explicitly set fields
* into account (since the constructor cannot distinguish explicit {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20181201")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = RuleSummary.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class RuleSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"id",
"displayName",
"description",
"lifecycleState",
"condition",
"compartmentId",
"isEnabled",
"timeCreated",
"freeformTags",
"definedTags"
})
public RuleSummary(
String id,
String displayName,
String description,
Rule.LifecycleState lifecycleState,
String condition,
String compartmentId,
Boolean isEnabled,
java.util.Date timeCreated,
java.util.Map freeformTags,
java.util.Map> definedTags) {
super();
this.id = id;
this.displayName = displayName;
this.description = description;
this.lifecycleState = lifecycleState;
this.condition = condition;
this.compartmentId = compartmentId;
this.isEnabled = isEnabled;
this.timeCreated = timeCreated;
this.freeformTags = freeformTags;
this.definedTags = definedTags;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
* of this rule.
*/
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
* of this rule.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/**
* A string that describes the rule. It does not have to be unique, and you can change it.
* Avoid entering confidential information.
*
* Example: {@code "This rule sends a notification upon completion of DbaaS backup."}
*/
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private String displayName;
/**
* A string that describes the rule. It does not have to be unique, and you can change it.
* Avoid entering confidential information.
*
*
Example: {@code "This rule sends a notification upon completion of DbaaS backup."}
*
* @param displayName the value to set
* @return this builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
this.__explicitlySet__.add("displayName");
return this;
}
/**
* A string that describes the details of the rule. It does not have to be unique, and you
* can change it. Avoid entering confidential information.
*/
@com.fasterxml.jackson.annotation.JsonProperty("description")
private String description;
/**
* A string that describes the details of the rule. It does not have to be unique, and you
* can change it. Avoid entering confidential information.
*
* @param description the value to set
* @return this builder
*/
public Builder description(String description) {
this.description = description;
this.__explicitlySet__.add("description");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private Rule.LifecycleState lifecycleState;
public Builder lifecycleState(Rule.LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
/**
* A filter that specifies the event that will trigger actions associated with this rule. A
* few important things to remember about filters:
*
*
Fields not mentioned in the condition are ignored. You can create a valid filter that
* matches all events with two curly brackets: {@code {}}
*
*
For more examples, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). *
* For a condition with fields to match an event, the event must contain all the field names
* listed in the condition. Field names must appear in the condition with the same nesting
* structure used in the event.
*
*
For a list of reference events, see [Services that Produce
* Events](https://docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm).
* * Rules apply to events in the compartment in which you create them and any child
* compartments. This means that a condition specified by a rule only matches events emitted
* from resources in the compartment or any of its child compartments. * Wildcard matching
* is supported with the asterisk (*) character.
*
*
For examples of wildcard matching, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)
*
*
Example: {@code \\"eventType\\":
* \\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\"}
*/
@com.fasterxml.jackson.annotation.JsonProperty("condition")
private String condition;
/**
* A filter that specifies the event that will trigger actions associated with this rule. A
* few important things to remember about filters:
*
*
Fields not mentioned in the condition are ignored. You can create a valid filter that
* matches all events with two curly brackets: {@code {}}
*
*
For more examples, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). *
* For a condition with fields to match an event, the event must contain all the field names
* listed in the condition. Field names must appear in the condition with the same nesting
* structure used in the event.
*
*
For a list of reference events, see [Services that Produce
* Events](https://docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm).
* * Rules apply to events in the compartment in which you create them and any child
* compartments. This means that a condition specified by a rule only matches events emitted
* from resources in the compartment or any of its child compartments. * Wildcard matching
* is supported with the asterisk (*) character.
*
*
For examples of wildcard matching, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)
*
*
Example: {@code \\"eventType\\":
* \\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\"}
*
* @param condition the value to set
* @return this builder
*/
public Builder condition(String condition) {
this.condition = condition;
this.__explicitlySet__.add("condition");
return this;
}
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
* of the compartment to which this rule belongs.
*/
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
* of the compartment to which this rule belongs.
*
* @param compartmentId the value to set
* @return this builder
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
/**
* Whether or not this rule is currently enabled.
*
*
Example: {@code true}
*/
@com.fasterxml.jackson.annotation.JsonProperty("isEnabled")
private Boolean isEnabled;
/**
* Whether or not this rule is currently enabled.
*
*
Example: {@code true}
*
* @param isEnabled the value to set
* @return this builder
*/
public Builder isEnabled(Boolean isEnabled) {
this.isEnabled = isEnabled;
this.__explicitlySet__.add("isEnabled");
return this;
}
/**
* The time this rule was created, expressed in [RFC
* 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
*
*
Example: {@code 2018-09-12T22:47:12.613Z}
*/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
/**
* The time this rule was created, expressed in [RFC
* 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
*
*
Example: {@code 2018-09-12T22:47:12.613Z}
*
* @param timeCreated the value to set
* @return this builder
*/
public Builder timeCreated(java.util.Date timeCreated) {
this.timeCreated = timeCreated;
this.__explicitlySet__.add("timeCreated");
return this;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. Exists for cross-compatibility only. For more information, see
* [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*
Example: {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private java.util.Map freeformTags;
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. Exists for cross-compatibility only. For more information, see
* [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*
* @param freeformTags the value to set
* @return this builder
*/
public Builder freeformTags(java.util.Map freeformTags) {
this.freeformTags = freeformTags;
this.__explicitlySet__.add("freeformTags");
return this;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*
* @param definedTags the value to set
* @return this builder
*/
public Builder definedTags(
java.util.Map> definedTags) {
this.definedTags = definedTags;
this.__explicitlySet__.add("definedTags");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public RuleSummary build() {
RuleSummary model =
new RuleSummary(
this.id,
this.displayName,
this.description,
this.lifecycleState,
this.condition,
this.compartmentId,
this.isEnabled,
this.timeCreated,
this.freeformTags,
this.definedTags);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(RuleSummary model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("displayName")) {
this.displayName(model.getDisplayName());
}
if (model.wasPropertyExplicitlySet("description")) {
this.description(model.getDescription());
}
if (model.wasPropertyExplicitlySet("lifecycleState")) {
this.lifecycleState(model.getLifecycleState());
}
if (model.wasPropertyExplicitlySet("condition")) {
this.condition(model.getCondition());
}
if (model.wasPropertyExplicitlySet("compartmentId")) {
this.compartmentId(model.getCompartmentId());
}
if (model.wasPropertyExplicitlySet("isEnabled")) {
this.isEnabled(model.getIsEnabled());
}
if (model.wasPropertyExplicitlySet("timeCreated")) {
this.timeCreated(model.getTimeCreated());
}
if (model.wasPropertyExplicitlySet("freeformTags")) {
this.freeformTags(model.getFreeformTags());
}
if (model.wasPropertyExplicitlySet("definedTags")) {
this.definedTags(model.getDefinedTags());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of
* this rule.
*/
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of
* this rule.
*
* @return the value
*/
public String getId() {
return id;
}
/**
* A string that describes the rule. It does not have to be unique, and you can change it. Avoid
* entering confidential information.
*
* Example: {@code "This rule sends a notification upon completion of DbaaS backup."}
*/
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private final String displayName;
/**
* A string that describes the rule. It does not have to be unique, and you can change it. Avoid
* entering confidential information.
*
*
Example: {@code "This rule sends a notification upon completion of DbaaS backup."}
*
* @return the value
*/
public String getDisplayName() {
return displayName;
}
/**
* A string that describes the details of the rule. It does not have to be unique, and you can
* change it. Avoid entering confidential information.
*/
@com.fasterxml.jackson.annotation.JsonProperty("description")
private final String description;
/**
* A string that describes the details of the rule. It does not have to be unique, and you can
* change it. Avoid entering confidential information.
*
* @return the value
*/
public String getDescription() {
return description;
}
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private final Rule.LifecycleState lifecycleState;
public Rule.LifecycleState getLifecycleState() {
return lifecycleState;
}
/**
* A filter that specifies the event that will trigger actions associated with this rule. A few
* important things to remember about filters:
*
*
Fields not mentioned in the condition are ignored. You can create a valid filter that
* matches all events with two curly brackets: {@code {}}
*
*
For more examples, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). * For
* a condition with fields to match an event, the event must contain all the field names listed
* in the condition. Field names must appear in the condition with the same nesting structure
* used in the event.
*
*
For a list of reference events, see [Services that Produce
* Events](https://docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). *
* Rules apply to events in the compartment in which you create them and any child compartments.
* This means that a condition specified by a rule only matches events emitted from resources in
* the compartment or any of its child compartments. * Wildcard matching is supported with the
* asterisk (*) character.
*
*
For examples of wildcard matching, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)
*
*
Example: {@code \\"eventType\\":
* \\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\"}
*/
@com.fasterxml.jackson.annotation.JsonProperty("condition")
private final String condition;
/**
* A filter that specifies the event that will trigger actions associated with this rule. A few
* important things to remember about filters:
*
*
Fields not mentioned in the condition are ignored. You can create a valid filter that
* matches all events with two curly brackets: {@code {}}
*
*
For more examples, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). * For
* a condition with fields to match an event, the event must contain all the field names listed
* in the condition. Field names must appear in the condition with the same nesting structure
* used in the event.
*
*
For a list of reference events, see [Services that Produce
* Events](https://docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). *
* Rules apply to events in the compartment in which you create them and any child compartments.
* This means that a condition specified by a rule only matches events emitted from resources in
* the compartment or any of its child compartments. * Wildcard matching is supported with the
* asterisk (*) character.
*
*
For examples of wildcard matching, see [Matching Events with
* Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)
*
*
Example: {@code \\"eventType\\":
* \\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\"}
*
* @return the value
*/
public String getCondition() {
return condition;
}
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of
* the compartment to which this rule belongs.
*/
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private final String compartmentId;
/**
* The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of
* the compartment to which this rule belongs.
*
* @return the value
*/
public String getCompartmentId() {
return compartmentId;
}
/**
* Whether or not this rule is currently enabled.
*
*
Example: {@code true}
*/
@com.fasterxml.jackson.annotation.JsonProperty("isEnabled")
private final Boolean isEnabled;
/**
* Whether or not this rule is currently enabled.
*
*
Example: {@code true}
*
* @return the value
*/
public Boolean getIsEnabled() {
return isEnabled;
}
/**
* The time this rule was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)
* timestamp format.
*
*
Example: {@code 2018-09-12T22:47:12.613Z}
*/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private final java.util.Date timeCreated;
/**
* The time this rule was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)
* timestamp format.
*
*
Example: {@code 2018-09-12T22:47:12.613Z}
*
* @return the value
*/
public java.util.Date getTimeCreated() {
return timeCreated;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. Exists for cross-compatibility only. For more information, see
* [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*
Example: {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private final java.util.Map freeformTags;
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. Exists for cross-compatibility only. For more information, see
* [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*
* @return the value
*/
public java.util.Map getFreeformTags() {
return freeformTags;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private final java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*
* @return the value
*/
public java.util.Map> getDefinedTags() {
return definedTags;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("RuleSummary(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", displayName=").append(String.valueOf(this.displayName));
sb.append(", description=").append(String.valueOf(this.description));
sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(", condition=").append(String.valueOf(this.condition));
sb.append(", compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(", isEnabled=").append(String.valueOf(this.isEnabled));
sb.append(", timeCreated=").append(String.valueOf(this.timeCreated));
sb.append(", freeformTags=").append(String.valueOf(this.freeformTags));
sb.append(", definedTags=").append(String.valueOf(this.definedTags));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof RuleSummary)) {
return false;
}
RuleSummary other = (RuleSummary) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.displayName, other.displayName)
&& java.util.Objects.equals(this.description, other.description)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& java.util.Objects.equals(this.condition, other.condition)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.isEnabled, other.isEnabled)
&& java.util.Objects.equals(this.timeCreated, other.timeCreated)
&& java.util.Objects.equals(this.freeformTags, other.freeformTags)
&& java.util.Objects.equals(this.definedTags, other.definedTags)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.id == null ? 43 : this.id.hashCode());
result = (result * PRIME) + (this.displayName == null ? 43 : this.displayName.hashCode());
result = (result * PRIME) + (this.description == null ? 43 : this.description.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result = (result * PRIME) + (this.condition == null ? 43 : this.condition.hashCode());
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result = (result * PRIME) + (this.isEnabled == null ? 43 : this.isEnabled.hashCode());
result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode());
result = (result * PRIME) + (this.freeformTags == null ? 43 : this.freeformTags.hashCode());
result = (result * PRIME) + (this.definedTags == null ? 43 : this.definedTags.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}