@Generated(value="OracleSDKGenerator",
comments="API Version: 20190501")
public final class Subscriber
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.
Note: Objects should always be created or deserialized using the Subscriber.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 Subscriber.Builder, which maintain a
set of all explicitly set fields called Subscriber.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 |
Subscriber.Builder |
static class |
Subscriber.LifecycleState
The current state of the subscriber.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Subscriber(String id,
String compartmentId,
String displayName,
List<Client> clients,
List<String> usagePlans,
Date timeCreated,
Date timeUpdated,
Subscriber.LifecycleState lifecycleState,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Subscriber.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<Client> |
getClients()
The clients belonging to this subscriber.
|
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 state in more detail.
|
Subscriber.LifecycleState |
getLifecycleState()
The current state of the subscriber.
|
Date |
getTimeCreated()
The time this resource was created.
|
Date |
getTimeUpdated()
The time this resource was last updated.
|
List<String> |
getUsagePlans()
An array of OCIDs
of usage plan resources.
|
int |
hashCode() |
Subscriber.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","displayName","clients","usagePlans","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags"}) public Subscriber(String id, String compartmentId, String displayName, List<Client> clients, List<String> usagePlans, Date timeCreated, Date timeUpdated, Subscriber.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Subscriber.Builder builder()
Create a new builder.
public Subscriber.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment in which the resource is created.
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 List<Client> getClients()
The clients belonging to this subscriber.
public List<String> getUsagePlans()
An array of OCIDs of usage plan resources.
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 Subscriber.LifecycleState getLifecycleState()
The current state of the subscriber.
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.
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.