com.oracle.bmc.apigateway.model

Class Entitlement

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.Entitlement

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class Entitlement
extends ExplicitlySetBmcModel

A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

Note: Objects should always be created or deserialized using the Entitlement.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 Entitlement.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entitlement.Builder

Constructor Summary

Constructors

Constructor and Description
Entitlement(String name, String description, RateLimit rateLimit, Quota quota, List<EntitlementTarget> targets) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Entitlement.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDescription() A user-friendly description.
String	getName() An entitlement name, unique within a usage plan.
Quota	getQuota()
RateLimit	getRateLimit()
List<EntitlementTarget>	getTargets() A collection of targeted deployments that the entitlement will be applied to.
int	hashCode()
Entitlement.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

Entitlement

@Deprecated
 @ConstructorProperties(value={"name","description","rateLimit","quota","targets"})
public Entitlement(String name,
                                                                                                                   String description,
                                                                                                                   RateLimit rateLimit,
                                                                                                                   Quota quota,
                                                                                                                   List<EntitlementTarget> targets)

Deprecated.

Method Detail

builder

public static Entitlement.Builder builder()

Create a new builder.

toBuilder

public Entitlement.Builder toBuilder()

getName

public String getName()

An entitlement name, unique within a usage plan.

Returns:

the value

getDescription

public String getDescription()

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

the value

getRateLimit

public RateLimit getRateLimit()

getQuota

public Quota getQuota()

getTargets

public List<EntitlementTarget> getTargets()

A collection of targeted deployments that the entitlement will be applied to.

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel