com.oracle.bmc.apigateway.model.GatewaySummary Maven / Gradle / Ivy
Show all versions of oci-java-sdk-apigateway 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.apigateway.model;
/**
* A summary of the gateway.
* 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: 20190501")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = GatewaySummary.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class GatewaySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"id",
"displayName",
"compartmentId",
"endpointType",
"subnetId",
"networkSecurityGroupIds",
"timeCreated",
"timeUpdated",
"lifecycleState",
"lifecycleDetails",
"hostname",
"certificateId",
"freeformTags",
"definedTags"
})
public GatewaySummary(
String id,
String displayName,
String compartmentId,
Gateway.EndpointType endpointType,
String subnetId,
java.util.List networkSecurityGroupIds,
java.util.Date timeCreated,
java.util.Date timeUpdated,
Gateway.LifecycleState lifecycleState,
String lifecycleDetails,
String hostname,
String certificateId,
java.util.Map freeformTags,
java.util.Map> definedTags) {
super();
this.id = id;
this.displayName = displayName;
this.compartmentId = compartmentId;
this.endpointType = endpointType;
this.subnetId = subnetId;
this.networkSecurityGroupIds = networkSecurityGroupIds;
this.timeCreated = timeCreated;
this.timeUpdated = timeUpdated;
this.lifecycleState = lifecycleState;
this.lifecycleDetails = lifecycleDetails;
this.hostname = hostname;
this.certificateId = certificateId;
this.freeformTags = freeformTags;
this.definedTags = definedTags;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*/
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/**
* A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
* confidential information.
*
* Example: {@code My new resource}
*/
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private String displayName;
/**
* A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
* confidential information.
*
*
Example: {@code My new resource}
*
* @param displayName the value to set
* @return this builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
this.__explicitlySet__.add("displayName");
return this;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* compartment in which the resource is created.
*/
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* compartment in which the resource is created.
*
* @param compartmentId the value to set
* @return this builder
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
/**
* Gateway endpoint type. {@code PUBLIC} will have a public ip address assigned to it, while
* {@code PRIVATE} will only be accessible on a private IP address on the subnet.
*
*
Example: {@code PUBLIC} or {@code PRIVATE}
*/
@com.fasterxml.jackson.annotation.JsonProperty("endpointType")
private Gateway.EndpointType endpointType;
/**
* Gateway endpoint type. {@code PUBLIC} will have a public ip address assigned to it, while
* {@code PRIVATE} will only be accessible on a private IP address on the subnet.
*
*
Example: {@code PUBLIC} or {@code PRIVATE}
*
* @param endpointType the value to set
* @return this builder
*/
public Builder endpointType(Gateway.EndpointType endpointType) {
this.endpointType = endpointType;
this.__explicitlySet__.add("endpointType");
return this;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* subnet in which related resources are created.
*/
@com.fasterxml.jackson.annotation.JsonProperty("subnetId")
private String subnetId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* subnet in which related resources are created.
*
* @param subnetId the value to set
* @return this builder
*/
public Builder subnetId(String subnetId) {
this.subnetId = subnetId;
this.__explicitlySet__.add("subnetId");
return this;
}
/** An array of Network Security Groups OCIDs associated with this API Gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("networkSecurityGroupIds")
private java.util.List networkSecurityGroupIds;
/**
* An array of Network Security Groups OCIDs associated with this API Gateway.
*
* @param networkSecurityGroupIds the value to set
* @return this builder
*/
public Builder networkSecurityGroupIds(java.util.List networkSecurityGroupIds) {
this.networkSecurityGroupIds = networkSecurityGroupIds;
this.__explicitlySet__.add("networkSecurityGroupIds");
return this;
}
/** The time this resource was created. An RFC3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
/**
* The time this resource was created. An RFC3339 formatted datetime string.
*
* @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;
}
/** The time this resource was last updated. An RFC3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
private java.util.Date timeUpdated;
/**
* The time this resource was last updated. An RFC3339 formatted datetime string.
*
* @param timeUpdated the value to set
* @return this builder
*/
public Builder timeUpdated(java.util.Date timeUpdated) {
this.timeUpdated = timeUpdated;
this.__explicitlySet__.add("timeUpdated");
return this;
}
/** The current state of the gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private Gateway.LifecycleState lifecycleState;
/**
* The current state of the gateway.
*
* @param lifecycleState the value to set
* @return this builder
*/
public Builder lifecycleState(Gateway.LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
/**
* A message describing the current state in more detail. For example, can be used to
* provide actionable information for a resource in a Failed state.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails")
private String lifecycleDetails;
/**
* A message describing the current state in more detail. For example, can be used to
* provide actionable information for a resource in a Failed state.
*
* @param lifecycleDetails the value to set
* @return this builder
*/
public Builder lifecycleDetails(String lifecycleDetails) {
this.lifecycleDetails = lifecycleDetails;
this.__explicitlySet__.add("lifecycleDetails");
return this;
}
/** The hostname for the APIs deployed on the gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("hostname")
private String hostname;
/**
* The hostname for the APIs deployed on the gateway.
*
* @param hostname the value to set
* @return this builder
*/
public Builder hostname(String hostname) {
this.hostname = hostname;
this.__explicitlySet__.add("hostname");
return this;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*/
@com.fasterxml.jackson.annotation.JsonProperty("certificateId")
private String certificateId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*
* @param certificateId the value to set
* @return this builder
*/
public Builder certificateId(String certificateId) {
this.certificateId = certificateId;
this.__explicitlySet__.add("certificateId");
return this;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/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. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/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/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/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 GatewaySummary build() {
GatewaySummary model =
new GatewaySummary(
this.id,
this.displayName,
this.compartmentId,
this.endpointType,
this.subnetId,
this.networkSecurityGroupIds,
this.timeCreated,
this.timeUpdated,
this.lifecycleState,
this.lifecycleDetails,
this.hostname,
this.certificateId,
this.freeformTags,
this.definedTags);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(GatewaySummary model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("displayName")) {
this.displayName(model.getDisplayName());
}
if (model.wasPropertyExplicitlySet("compartmentId")) {
this.compartmentId(model.getCompartmentId());
}
if (model.wasPropertyExplicitlySet("endpointType")) {
this.endpointType(model.getEndpointType());
}
if (model.wasPropertyExplicitlySet("subnetId")) {
this.subnetId(model.getSubnetId());
}
if (model.wasPropertyExplicitlySet("networkSecurityGroupIds")) {
this.networkSecurityGroupIds(model.getNetworkSecurityGroupIds());
}
if (model.wasPropertyExplicitlySet("timeCreated")) {
this.timeCreated(model.getTimeCreated());
}
if (model.wasPropertyExplicitlySet("timeUpdated")) {
this.timeUpdated(model.getTimeUpdated());
}
if (model.wasPropertyExplicitlySet("lifecycleState")) {
this.lifecycleState(model.getLifecycleState());
}
if (model.wasPropertyExplicitlySet("lifecycleDetails")) {
this.lifecycleDetails(model.getLifecycleDetails());
}
if (model.wasPropertyExplicitlySet("hostname")) {
this.hostname(model.getHostname());
}
if (model.wasPropertyExplicitlySet("certificateId")) {
this.certificateId(model.getCertificateId());
}
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/Content/General/Concepts/identifiers.htm) of the
* resource.
*/
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*
* @return the value
*/
public String getId() {
return id;
}
/**
* A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
* confidential information.
*
* Example: {@code My new resource}
*/
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private final String displayName;
/**
* A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering
* confidential information.
*
*
Example: {@code My new resource}
*
* @return the value
*/
public String getDisplayName() {
return displayName;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* compartment in which the resource is created.
*/
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private final String compartmentId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* compartment in which the resource is created.
*
* @return the value
*/
public String getCompartmentId() {
return compartmentId;
}
/**
* Gateway endpoint type. {@code PUBLIC} will have a public ip address assigned to it, while
* {@code PRIVATE} will only be accessible on a private IP address on the subnet.
*
*
Example: {@code PUBLIC} or {@code PRIVATE}
*/
@com.fasterxml.jackson.annotation.JsonProperty("endpointType")
private final Gateway.EndpointType endpointType;
/**
* Gateway endpoint type. {@code PUBLIC} will have a public ip address assigned to it, while
* {@code PRIVATE} will only be accessible on a private IP address on the subnet.
*
*
Example: {@code PUBLIC} or {@code PRIVATE}
*
* @return the value
*/
public Gateway.EndpointType getEndpointType() {
return endpointType;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* subnet in which related resources are created.
*/
@com.fasterxml.jackson.annotation.JsonProperty("subnetId")
private final String subnetId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* subnet in which related resources are created.
*
* @return the value
*/
public String getSubnetId() {
return subnetId;
}
/** An array of Network Security Groups OCIDs associated with this API Gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("networkSecurityGroupIds")
private final java.util.List networkSecurityGroupIds;
/**
* An array of Network Security Groups OCIDs associated with this API Gateway.
*
* @return the value
*/
public java.util.List getNetworkSecurityGroupIds() {
return networkSecurityGroupIds;
}
/** The time this resource was created. An RFC3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private final java.util.Date timeCreated;
/**
* The time this resource was created. An RFC3339 formatted datetime string.
*
* @return the value
*/
public java.util.Date getTimeCreated() {
return timeCreated;
}
/** The time this resource was last updated. An RFC3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
private final java.util.Date timeUpdated;
/**
* The time this resource was last updated. An RFC3339 formatted datetime string.
*
* @return the value
*/
public java.util.Date getTimeUpdated() {
return timeUpdated;
}
/** The current state of the gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private final Gateway.LifecycleState lifecycleState;
/**
* The current state of the gateway.
*
* @return the value
*/
public Gateway.LifecycleState getLifecycleState() {
return lifecycleState;
}
/**
* A message describing the current state in more detail. For example, can be used to provide
* actionable information for a resource in a Failed state.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails")
private final String lifecycleDetails;
/**
* A message describing the current state in more detail. For example, can be used to provide
* actionable information for a resource in a Failed state.
*
* @return the value
*/
public String getLifecycleDetails() {
return lifecycleDetails;
}
/** The hostname for the APIs deployed on the gateway. */
@com.fasterxml.jackson.annotation.JsonProperty("hostname")
private final String hostname;
/**
* The hostname for the APIs deployed on the gateway.
*
* @return the value
*/
public String getHostname() {
return hostname;
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*/
@com.fasterxml.jackson.annotation.JsonProperty("certificateId")
private final String certificateId;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the
* resource.
*
* @return the value
*/
public String getCertificateId() {
return certificateId;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/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. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/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/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/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("GatewaySummary(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", displayName=").append(String.valueOf(this.displayName));
sb.append(", compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(", endpointType=").append(String.valueOf(this.endpointType));
sb.append(", subnetId=").append(String.valueOf(this.subnetId));
sb.append(", networkSecurityGroupIds=")
.append(String.valueOf(this.networkSecurityGroupIds));
sb.append(", timeCreated=").append(String.valueOf(this.timeCreated));
sb.append(", timeUpdated=").append(String.valueOf(this.timeUpdated));
sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(", lifecycleDetails=").append(String.valueOf(this.lifecycleDetails));
sb.append(", hostname=").append(String.valueOf(this.hostname));
sb.append(", certificateId=").append(String.valueOf(this.certificateId));
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 GatewaySummary)) {
return false;
}
GatewaySummary other = (GatewaySummary) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.displayName, other.displayName)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.endpointType, other.endpointType)
&& java.util.Objects.equals(this.subnetId, other.subnetId)
&& java.util.Objects.equals(
this.networkSecurityGroupIds, other.networkSecurityGroupIds)
&& java.util.Objects.equals(this.timeCreated, other.timeCreated)
&& java.util.Objects.equals(this.timeUpdated, other.timeUpdated)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& java.util.Objects.equals(this.lifecycleDetails, other.lifecycleDetails)
&& java.util.Objects.equals(this.hostname, other.hostname)
&& java.util.Objects.equals(this.certificateId, other.certificateId)
&& 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.compartmentId == null ? 43 : this.compartmentId.hashCode());
result = (result * PRIME) + (this.endpointType == null ? 43 : this.endpointType.hashCode());
result = (result * PRIME) + (this.subnetId == null ? 43 : this.subnetId.hashCode());
result =
(result * PRIME)
+ (this.networkSecurityGroupIds == null
? 43
: this.networkSecurityGroupIds.hashCode());
result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode());
result = (result * PRIME) + (this.timeUpdated == null ? 43 : this.timeUpdated.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result =
(result * PRIME)
+ (this.lifecycleDetails == null ? 43 : this.lifecycleDetails.hashCode());
result = (result * PRIME) + (this.hostname == null ? 43 : this.hostname.hashCode());
result =
(result * PRIME)
+ (this.certificateId == null ? 43 : this.certificateId.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;
}
}