@Generated(value="OracleSDKGenerator",
comments="API Version: 20190501")
public final class Api
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An API is simple container for an API Specification. For more information, see API Gateway
Concepts.
Note: Objects should always be created or deserialized using the Api.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Api.Builder, which maintain a
set of all explicitly set fields called Api.Builder.__explicitlySet__. The hashCode() and 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 null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Api.Builder |
static class |
Api.LifecycleState
The current state of the API.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Api(String id,
String displayName,
String compartmentId,
Date timeCreated,
Date timeUpdated,
Api.LifecycleState lifecycleState,
String lifecycleDetails,
String specificationType,
List<ApiValidationResult> validationResults,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Api.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the
compartment in which the resource is created.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the
resource.
|
String |
getLifecycleDetails()
A message describing the current lifecycleState in more detail.
|
Api.LifecycleState |
getLifecycleState()
The current state of the API.
|
String |
getSpecificationType()
Type of API Specification file.
|
Date |
getTimeCreated()
The time this resource was created.
|
Date |
getTimeUpdated()
The time this resource was last updated.
|
List<ApiValidationResult> |
getValidationResults()
Status of each feature available from the API.
|
int |
hashCode() |
Api.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","specificationType","validationResults","freeformTags","definedTags"}) public Api(String id, String displayName, String compartmentId, Date timeCreated, Date timeUpdated, Api.LifecycleState lifecycleState, String lifecycleDetails, String specificationType, List<ApiValidationResult> validationResults, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Api.Builder builder()
Create a new builder.
public Api.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: My new resource
public String getCompartmentId()
The OCID of the compartment in which the resource is created.
public Date getTimeCreated()
The time this resource was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The time this resource was last updated. An RFC3339 formatted datetime string.
public Api.LifecycleState getLifecycleState()
The current state of the API.
public String getLifecycleDetails()
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.
public String getSpecificationType()
Type of API Specification file.
public List<ApiValidationResult> getValidationResults()
Status of each feature available from the API.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.