com.oracle.bmc.apigateway.model

Class GatewaySummary.Builder

java.lang.Object

com.oracle.bmc.apigateway.model.GatewaySummary.Builder

Enclosing class:

GatewaySummary

public static class GatewaySummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GatewaySummary	build()
GatewaySummary.Builder	certificateId(String certificateId) The OCID of the resource.
GatewaySummary.Builder	compartmentId(String compartmentId) The OCID of the compartment in which the resource is created.
GatewaySummary.Builder	copy(GatewaySummary model)
GatewaySummary.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
GatewaySummary.Builder	displayName(String displayName) A user-friendly name.
GatewaySummary.Builder	endpointType(Gateway.EndpointType endpointType) Gateway endpoint type.
GatewaySummary.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
GatewaySummary.Builder	hostname(String hostname) The hostname for the APIs deployed on the gateway.
GatewaySummary.Builder	id(String id) The OCID of the resource.
GatewaySummary.Builder	lifecycleDetails(String lifecycleDetails) A message describing the current state in more detail.
GatewaySummary.Builder	lifecycleState(Gateway.LifecycleState lifecycleState) The current state of the gateway.
GatewaySummary.Builder	networkSecurityGroupIds(List<String> networkSecurityGroupIds) An array of Network Security Groups OCIDs associated with this API Gateway.
GatewaySummary.Builder	subnetId(String subnetId) The OCID of the subnet in which related resources are created.
GatewaySummary.Builder	timeCreated(Date timeCreated) The time this resource was created.
GatewaySummary.Builder	timeUpdated(Date timeUpdated) The time this resource was last updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public GatewaySummary.Builder id(String id)

The OCID of the resource.

Parameters:

id - the value to set

Returns:

this builder

displayName

public GatewaySummary.Builder displayName(String displayName)

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Parameters:

displayName - the value to set

Returns:

this builder

compartmentId

public GatewaySummary.Builder compartmentId(String compartmentId)

The OCID of the compartment in which the resource is created.

Parameters:

compartmentId - the value to set

Returns:

this builder

endpointType

public GatewaySummary.Builder endpointType(Gateway.EndpointType endpointType)

Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

Example: PUBLIC or PRIVATE

Parameters:

endpointType - the value to set

Returns:

this builder

subnetId

public GatewaySummary.Builder subnetId(String subnetId)

The OCID of the subnet in which related resources are created.

Parameters:

subnetId - the value to set

Returns:

this builder

networkSecurityGroupIds

public GatewaySummary.Builder networkSecurityGroupIds(List<String> networkSecurityGroupIds)

An array of Network Security Groups OCIDs associated with this API Gateway.

Parameters:

networkSecurityGroupIds - the value to set

Returns:

this builder

timeCreated

public GatewaySummary.Builder timeCreated(Date timeCreated)

The time this resource was created. An RFC3339 formatted datetime string.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public GatewaySummary.Builder timeUpdated(Date timeUpdated)

The time this resource was last updated. An RFC3339 formatted datetime string.

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public GatewaySummary.Builder lifecycleState(Gateway.LifecycleState lifecycleState)

The current state of the gateway.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public GatewaySummary.Builder lifecycleDetails(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.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

hostname

public GatewaySummary.Builder hostname(String hostname)

The hostname for the APIs deployed on the gateway.

Parameters:

hostname - the value to set

Returns:

this builder

certificateId

public GatewaySummary.Builder certificateId(String certificateId)

The OCID of the resource.

Parameters:

certificateId - the value to set

Returns:

this builder

freeformTags

public GatewaySummary.Builder freeformTags(Map<String,String> 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.

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public GatewaySummary.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

build

public GatewaySummary build()

copy

public GatewaySummary.Builder copy(GatewaySummary model)