com.oracle.bmc.apigateway.model

Class ApiSummary.Builder

java.lang.Object

com.oracle.bmc.apigateway.model.ApiSummary.Builder

Enclosing class:

ApiSummary

public static class ApiSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApiSummary	build()
ApiSummary.Builder	compartmentId(String compartmentId) The OCID of the compartment in which the resource is created.
ApiSummary.Builder	copy(ApiSummary model)
ApiSummary.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
ApiSummary.Builder	displayName(String displayName) A user-friendly name.
ApiSummary.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
ApiSummary.Builder	id(String id) The OCID of the resource.
ApiSummary.Builder	lifecycleDetails(String lifecycleDetails) A message describing the current lifecycleState in more detail.
ApiSummary.Builder	lifecycleState(ApiSummary.LifecycleState lifecycleState) The current state of the API.
ApiSummary.Builder	specificationType(String specificationType) Type of API Specification file.
ApiSummary.Builder	timeCreated(Date timeCreated) The time this resource was created.
ApiSummary.Builder	timeUpdated(Date timeUpdated) The time this resource was last updated.
ApiSummary.Builder	validationResults(List<ApiValidationResult> validationResults) Status of each feature available from the API.

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 ApiSummary.Builder id(String id)

The OCID of the resource.

Parameters:

id - the value to set

Returns:

this builder

displayName

public ApiSummary.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 ApiSummary.Builder compartmentId(String compartmentId)

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

Parameters:

compartmentId - the value to set

Returns:

this builder

timeCreated

public ApiSummary.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 ApiSummary.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 ApiSummary.Builder lifecycleState(ApiSummary.LifecycleState lifecycleState)

The current state of the API.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public ApiSummary.Builder lifecycleDetails(String lifecycleDetails)

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: - ‘New’ for just updated API Specifications - ‘Validating’ for a document which is being validated. - ‘Valid’ the document has been validated without any errors or warnings - ‘Warning’ the document has been validated and contains warnings - ‘Error’ the document has been validated and contains errors - ‘Failed’ the document validation failed - ‘Canceled’ the document validation was canceled

For other states it may provide more details like actionable information.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

specificationType

public ApiSummary.Builder specificationType(String specificationType)

Type of API Specification file.

Parameters:

specificationType - the value to set

Returns:

this builder

validationResults

public ApiSummary.Builder validationResults(List<ApiValidationResult> validationResults)

Status of each feature available from the API.

Parameters:

validationResults - the value to set

Returns:

this builder

freeformTags

public ApiSummary.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 ApiSummary.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 ApiSummary build()

copy

public ApiSummary.Builder copy(ApiSummary model)