com.oracle.bmc.apigateway.model.Gateway Maven / Gradle / Ivy
Show all versions of oci-java-sdk-apigateway Show documentation
/**
* Copyright (c) 2016, 2021, 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 gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see
* [API Gateway Concepts](https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.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 #__explicitlySet__}. The {@link #hashCode()} and {@link #equals(Object)} methods are implemented to take
* {@link #__explicitlySet__} into account. The constructor, on the other hand, does not set {@link #__explicitlySet__}
* (since the constructor cannot distinguish explicit {@code null} from unset {@code null}).
**/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
@lombok.AllArgsConstructor(onConstructor = @__({@Deprecated}))
@lombok.Value
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = Gateway.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(com.oracle.bmc.http.internal.ExplicitlySetFilter.NAME)
@lombok.Builder(builderClassName = "Builder", toBuilder = true)
public class Gateway {
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
@lombok.experimental.Accessors(fluent = true)
public static class Builder {
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private String displayName;
public Builder displayName(String displayName) {
this.displayName = displayName;
this.__explicitlySet__.add("displayName");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("endpointType")
private EndpointType endpointType;
public Builder endpointType(EndpointType endpointType) {
this.endpointType = endpointType;
this.__explicitlySet__.add("endpointType");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("subnetId")
private String subnetId;
public Builder subnetId(String subnetId) {
this.subnetId = subnetId;
this.__explicitlySet__.add("subnetId");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("networkSecurityGroupIds")
private java.util.List networkSecurityGroupIds;
public Builder networkSecurityGroupIds(java.util.List networkSecurityGroupIds) {
this.networkSecurityGroupIds = networkSecurityGroupIds;
this.__explicitlySet__.add("networkSecurityGroupIds");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
public Builder timeCreated(java.util.Date timeCreated) {
this.timeCreated = timeCreated;
this.__explicitlySet__.add("timeCreated");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
private java.util.Date timeUpdated;
public Builder timeUpdated(java.util.Date timeUpdated) {
this.timeUpdated = timeUpdated;
this.__explicitlySet__.add("timeUpdated");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private LifecycleState lifecycleState;
public Builder lifecycleState(LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails")
private String lifecycleDetails;
public Builder lifecycleDetails(String lifecycleDetails) {
this.lifecycleDetails = lifecycleDetails;
this.__explicitlySet__.add("lifecycleDetails");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("hostname")
private String hostname;
public Builder hostname(String hostname) {
this.hostname = hostname;
this.__explicitlySet__.add("hostname");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("certificateId")
private String certificateId;
public Builder certificateId(String certificateId) {
this.certificateId = certificateId;
this.__explicitlySet__.add("certificateId");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("ipAddresses")
private java.util.List ipAddresses;
public Builder ipAddresses(java.util.List ipAddresses) {
this.ipAddresses = ipAddresses;
this.__explicitlySet__.add("ipAddresses");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("responseCacheDetails")
private ResponseCacheDetails responseCacheDetails;
public Builder responseCacheDetails(ResponseCacheDetails responseCacheDetails) {
this.responseCacheDetails = responseCacheDetails;
this.__explicitlySet__.add("responseCacheDetails");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private java.util.Map freeformTags;
public Builder freeformTags(java.util.Map freeformTags) {
this.freeformTags = freeformTags;
this.__explicitlySet__.add("freeformTags");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private java.util.Map> definedTags;
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 Gateway build() {
Gateway __instance__ =
new Gateway(
id,
displayName,
compartmentId,
endpointType,
subnetId,
networkSecurityGroupIds,
timeCreated,
timeUpdated,
lifecycleState,
lifecycleDetails,
hostname,
certificateId,
ipAddresses,
responseCacheDetails,
freeformTags,
definedTags);
__instance__.__explicitlySet__.addAll(__explicitlySet__);
return __instance__;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(Gateway o) {
Builder copiedBuilder =
id(o.getId())
.displayName(o.getDisplayName())
.compartmentId(o.getCompartmentId())
.endpointType(o.getEndpointType())
.subnetId(o.getSubnetId())
.networkSecurityGroupIds(o.getNetworkSecurityGroupIds())
.timeCreated(o.getTimeCreated())
.timeUpdated(o.getTimeUpdated())
.lifecycleState(o.getLifecycleState())
.lifecycleDetails(o.getLifecycleDetails())
.hostname(o.getHostname())
.certificateId(o.getCertificateId())
.ipAddresses(o.getIpAddresses())
.responseCacheDetails(o.getResponseCacheDetails())
.freeformTags(o.getFreeformTags())
.definedTags(o.getDefinedTags());
copiedBuilder.__explicitlySet__.retainAll(o.__explicitlySet__);
return copiedBuilder;
}
}
/**
* Create a new builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("id")
String 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")
String 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")
String 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}
*
**/
@lombok.extern.slf4j.Slf4j
public enum EndpointType {
Public("PUBLIC"),
Private("PRIVATE"),
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownEnumValue(null);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (EndpointType v : EndpointType.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
EndpointType(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static EndpointType create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'EndpointType', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/**
* 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")
EndpointType 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")
String subnetId;
/**
* An array of Network Security Groups OCIDs associated with this API Gateway.
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("networkSecurityGroupIds")
java.util.List networkSecurityGroupIds;
/**
* The time this resource was created. An RFC3339 formatted datetime string.
**/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
java.util.Date timeCreated;
/**
* The time this resource was last updated. An RFC3339 formatted datetime string.
**/
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
java.util.Date timeUpdated;
/**
* The current state of the gateway.
**/
@lombok.extern.slf4j.Slf4j
public enum LifecycleState {
Creating("CREATING"),
Active("ACTIVE"),
Updating("UPDATING"),
Deleting("DELETING"),
Deleted("DELETED"),
Failed("FAILED"),
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownEnumValue(null);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (LifecycleState v : LifecycleState.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
LifecycleState(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static LifecycleState create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'LifecycleState', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/**
* The current state of the gateway.
**/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
LifecycleState 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")
String lifecycleDetails;
/**
* The hostname for APIs deployed on the gateway.
**/
@com.fasterxml.jackson.annotation.JsonProperty("hostname")
String hostname;
/**
* The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("certificateId")
String certificateId;
/**
* An array of IP addresses associated with the gateway.
**/
@com.fasterxml.jackson.annotation.JsonProperty("ipAddresses")
java.util.List ipAddresses;
@com.fasterxml.jackson.annotation.JsonProperty("responseCacheDetails")
ResponseCacheDetails responseCacheDetails;
/**
* 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")
java.util.Map 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")
java.util.Map> definedTags;
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
}