com.oracle.bmc.ons.model

Class CreateSubscriptionDetails

java.lang.Object

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

com.oracle.bmc.ons.model.CreateSubscriptionDetails

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

The configuration details for creating the subscription.
Note: Objects should always be created or deserialized using the CreateSubscriptionDetails.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 CreateSubscriptionDetails.Builder, which maintain a set of all explicitly set fields called CreateSubscriptionDetails.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	CreateSubscriptionDetails.Builder

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
CreateSubscriptionDetails(String topicId, String compartmentId, String protocol, String endpoint, String metadata, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateSubscriptionDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the compartment for the subscription.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getEndpoint() A locator that corresponds to the subscription protocol.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getMetadata() Metadata for the subscription.
String	getProtocol() The protocol used for the subscription.
String	getTopicId() The OCID of the topic for the subscription.
int	hashCode()
CreateSubscriptionDetails.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

CreateSubscriptionDetails

@Deprecated
 @ConstructorProperties(value={"topicId","compartmentId","protocol","endpoint","metadata","freeformTags","definedTags"})
public CreateSubscriptionDetails(String topicId,
                                                                                                                                                                      String compartmentId,
                                                                                                                                                                      String protocol,
                                                                                                                                                                      String endpoint,
                                                                                                                                                                      String metadata,
                                                                                                                                                                      Map<String,String> freeformTags,
                                                                                                                                                                      Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateSubscriptionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateSubscriptionDetails.Builder toBuilder()

getTopicId

public String getTopicId()

The OCID of the topic for the subscription.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for the subscription.

Returns:

the value

getProtocol

public String getProtocol()

The protocol used for the subscription.

Allowed values: * CUSTOM_HTTPS * EMAIL * HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) * ORACLE_FUNCTIONS * PAGERDUTY * SLACK * SMS

For information about subscription protocols, see [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).

Returns:

the value

getEndpoint

public String getEndpoint()

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with “http:” or “https:”. A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).

Returns:

the value

getMetadata

public String getMetadata()

Metadata for the subscription.

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