Package com.oracle.bmc.limits.model

Class LimitDefinitionSummary

java.lang.Object

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

com.oracle.bmc.limits.model.LimitDefinitionSummary

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

The metadata specific to a resource limit definition.
Note: Objects should always be created or deserialized using the LimitDefinitionSummary.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 LimitDefinitionSummary.Builder, which maintain a set of all explicitly set fields called LimitDefinitionSummary.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	Description
static class	LimitDefinitionSummary.Builder
static class	LimitDefinitionSummary.ScopeType	Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

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	Description
LimitDefinitionSummary(String name, String serviceName, String description, LimitDefinitionSummary.ScopeType scopeType, Boolean areQuotasSupported, Boolean isResourceAvailabilitySupported, Boolean isDeprecated, Boolean isEligibleForLimitIncrease, Boolean isDynamic, List<String> supportedSubscriptions, List<String> supportedQuotaFamilies)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static LimitDefinitionSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getAreQuotasSupported()	If true, quota policies can be created on top of this resource limit.
String	getDescription()	The limit description.
Boolean	getIsDeprecated()	Indicates if the limit has been deprecated.
Boolean	getIsDynamic()	The limit for this resource has a dynamic value that is based on consumption across all OCI services.
Boolean	getIsEligibleForLimitIncrease()	Indicates if the customer can request a limit increase for this resource.
Boolean	getIsResourceAvailabilitySupported()	Reflects whether or not the GetResourceAvailability API is supported for this limit.
String	getName()	The resource limit name.
LimitDefinitionSummary.ScopeType	getScopeType()	Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
String	getServiceName()	The service name of the limit.
List<String>	getSupportedQuotaFamilies()	Supported quota family names for creation of quota policy.
List<String>	getSupportedSubscriptions()	An array of subscription types supported by the limit.
int	hashCode()
LimitDefinitionSummary.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

LimitDefinitionSummary

@Deprecated
@ConstructorProperties({"name","serviceName","description","scopeType","areQuotasSupported","isResourceAvailabilitySupported","isDeprecated","isEligibleForLimitIncrease","isDynamic","supportedSubscriptions","supportedQuotaFamilies"})
public LimitDefinitionSummary(String name,
                              String serviceName,
                              String description,
                              LimitDefinitionSummary.ScopeType scopeType,
                              Boolean areQuotasSupported,
                              Boolean isResourceAvailabilitySupported,
                              Boolean isDeprecated,
                              Boolean isEligibleForLimitIncrease,
                              Boolean isDynamic,
                              List<String> supportedSubscriptions,
                              List<String> supportedQuotaFamilies)

Deprecated.

Method Detail

builder

public static LimitDefinitionSummary.Builder builder()

Create a new builder.

toBuilder

public LimitDefinitionSummary.Builder toBuilder()

getName

public String getName()

The resource limit name.

To be used for writing policies (in case of quotas) or other programmatic calls.

Returns:

the value

getServiceName

public String getServiceName()

The service name of the limit.

Returns:

the value

getDescription

public String getDescription()

The limit description.

Returns:

the value

getScopeType

public LimitDefinitionSummary.ScopeType getScopeType()

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

Returns:

the value

getAreQuotasSupported

public Boolean getAreQuotasSupported()

If true, quota policies can be created on top of this resource limit.

Returns:

the value

getIsResourceAvailabilitySupported

public Boolean getIsResourceAvailabilitySupported()

Reflects whether or not the GetResourceAvailability API is supported for this limit.

If not, the API returns an empty JSON response.

Returns:

the value

getIsDeprecated

public Boolean getIsDeprecated()

Indicates if the limit has been deprecated.

Returns:

the value

getIsEligibleForLimitIncrease

public Boolean getIsEligibleForLimitIncrease()

Indicates if the customer can request a limit increase for this resource.

Returns:

the value

getIsDynamic

public Boolean getIsDynamic()

The limit for this resource has a dynamic value that is based on consumption across all OCI services.

Returns:

the value

getSupportedSubscriptions

public List<String> getSupportedSubscriptions()

An array of subscription types supported by the limit.

e,g The type of subscription, such as ‘SAAS’, ‘ERP’, ‘CRM’.

Returns:

the value

getSupportedQuotaFamilies

public List<String> getSupportedQuotaFamilies()

Supported quota family names for creation of quota policy.

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