com.oracle.bmc.apigateway.model

Class UsagePlan

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.UsagePlan

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class UsagePlan
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
Note: Objects should always be created or deserialized using the UsagePlan.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 UsagePlan.Builder, which maintain a set of all explicitly set fields called UsagePlan.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsagePlan.Builder
static class	UsagePlan.LifecycleState The current state of the usage plan.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
UsagePlan(String id, String displayName, List<Entitlement> entitlements, String compartmentId, Date timeCreated, Date timeUpdated, UsagePlan.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static UsagePlan.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.
List<Entitlement>	getEntitlements() A collection of entitlements currently assigned to the usage plan.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of a usage plan resource.
String	getLifecycleDetails() A message describing the current state in more detail.
UsagePlan.LifecycleState	getLifecycleState() The current state of the usage plan.
Date	getTimeCreated() The time this resource was created.
Date	getTimeUpdated() The time this resource was last updated.
int	hashCode()
UsagePlan.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UsagePlan

@Deprecated
 @ConstructorProperties(value={"id","displayName","entitlements","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags"})
public UsagePlan(String id,
                                                                                                                                                                                                             String displayName,
                                                                                                                                                                                                             List<Entitlement> entitlements,
                                                                                                                                                                                                             String compartmentId,
                                                                                                                                                                                                             Date timeCreated,
                                                                                                                                                                                                             Date timeUpdated,
                                                                                                                                                                                                             UsagePlan.LifecycleState lifecycleState,
                                                                                                                                                                                                             String lifecycleDetails,
                                                                                                                                                                                                             Map<String,String> freeformTags,
                                                                                                                                                                                                             Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static UsagePlan.Builder builder()

Create a new builder.

toBuilder

public UsagePlan.Builder toBuilder()

getId

public String getId()

The OCID of a usage plan resource.

Returns:

the value

getDisplayName

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

Returns:

the value

getEntitlements

public List<Entitlement> getEntitlements()

A collection of entitlements currently assigned to the usage plan.

Returns:

the value

getCompartmentId

public String getCompartmentId()

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

Returns:

the value

getTimeCreated

public Date getTimeCreated()

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

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

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

Returns:

the value

getLifecycleState

public UsagePlan.LifecycleState getLifecycleState()

The current state of the usage plan.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

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.

Returns:

the value

getFreeformTags

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"}

Returns:

the value

getDefinedTags

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"}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel