ServiceBus Class

Package:

com.azure.resourcemanager.digitaltwins.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.3.0

• java.lang.Object
• • com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties
  • • com.azure.resourcemanager.digitaltwins.models.ServiceBus

public final class ServiceBus
extends DigitalTwinsEndpointResourceProperties

Properties related to ServiceBus.

Constructor Summary

Constructor	Description
ServiceBus()	Creates an instance of ServiceBus class.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	createdTime() Get the createdTime property: Time when the Endpoint was added to DigitalTwinsInstance.
EndpointType	endpointType() Get the endpointType property: The type of Digital Twins endpoint.
String	endpointUri() Get the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication.
String	entityPath() Get the entityPath property: The ServiceBus Topic name for identity-based authentication.
static ServiceBus	fromJson(JsonReader jsonReader) Reads an instance of ServiceBus from the JsonReader.
String	primaryConnectionString() Get the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication.
EndpointProvisioningState	provisioningState() Get the provisioningState property: The provisioning state.
String	secondaryConnectionString() Get the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ServiceBus	withAuthenticationType(AuthenticationType authenticationType) Set the authenticationType property: Specifies the authentication type being used for connecting to the endpoint.
ServiceBus	withDeadLetterSecret(String deadLetterSecret) Set the deadLetterSecret property: Dead letter storage secret for key-based authentication.
ServiceBus	withDeadLetterUri(String deadLetterUri) Set the deadLetterUri property: Dead letter storage URL for identity-based authentication.
ServiceBus	withEndpointUri(String endpointUri) Set the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication.
ServiceBus	withEntityPath(String entityPath) Set the entityPath property: The ServiceBus Topic name for identity-based authentication.
ServiceBus	withIdentity(ManagedIdentityReference identity) Set the identity property: Managed identity properties for the endpoint.
ServiceBus	withPrimaryConnectionString(String primaryConnectionString) Set the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication.
ServiceBus	withSecondaryConnectionString(String secondaryConnectionString) Set the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication.

Methods inherited from DigitalTwinsEndpointResourceProperties

authenticationType createdTime deadLetterSecret deadLetterUri endpointType fromJson identity provisioningState toJson validate withAuthenticationType withDeadLetterSecret withDeadLetterUri withIdentity

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ServiceBus

public ServiceBus()

Creates an instance of ServiceBus class.

Method Details

createdTime

public OffsetDateTime createdTime()

Get the createdTime property: Time when the Endpoint was added to DigitalTwinsInstance.

Overrides:

ServiceBus.createdTime()

Returns:

the createdTime value.

endpointType

public EndpointType endpointType()

Get the endpointType property: The type of Digital Twins endpoint.

Overrides:

ServiceBus.endpointType()

Returns:

the endpointType value.

endpointUri

public String endpointUri()

Get the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.

Returns:

the endpointUri value.

entityPath

public String entityPath()

Get the entityPath property: The ServiceBus Topic name for identity-based authentication.

Returns:

the entityPath value.

fromJson

public static ServiceBus fromJson(JsonReader jsonReader)

Reads an instance of ServiceBus from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ServiceBus if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ServiceBus.

primaryConnectionString

public String primaryConnectionString()

Get the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

Returns:

the primaryConnectionString value.

provisioningState

public EndpointProvisioningState provisioningState()

Get the provisioningState property: The provisioning state.

Overrides:

ServiceBus.provisioningState()

Returns:

the provisioningState value.

secondaryConnectionString

public String secondaryConnectionString()

Get the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

Returns:

the secondaryConnectionString value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ServiceBus.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

Overrides:

ServiceBus.validate()

withAuthenticationType

public ServiceBus withAuthenticationType(AuthenticationType authenticationType)

Set the authenticationType property: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.

Overrides:

ServiceBus.withAuthenticationType(AuthenticationType authenticationType)

Parameters:

authenticationType

withDeadLetterSecret

public ServiceBus withDeadLetterSecret(String deadLetterSecret)

Set the deadLetterSecret property: Dead letter storage secret for key-based authentication. Will be obfuscated during read.

Overrides:

ServiceBus.withDeadLetterSecret(String deadLetterSecret)

Parameters:

deadLetterSecret

withDeadLetterUri

public ServiceBus withDeadLetterUri(String deadLetterUri)

Set the deadLetterUri property: Dead letter storage URL for identity-based authentication.

Overrides:

ServiceBus.withDeadLetterUri(String deadLetterUri)

Parameters:

deadLetterUri

withEndpointUri

public ServiceBus withEndpointUri(String endpointUri)

Set the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.

Parameters:

endpointUri - the endpointUri value to set.

Returns:

the ServiceBus object itself.

withEntityPath

public ServiceBus withEntityPath(String entityPath)

Set the entityPath property: The ServiceBus Topic name for identity-based authentication.

Parameters:

entityPath - the entityPath value to set.

Returns:

the ServiceBus object itself.

withIdentity

public ServiceBus withIdentity(ManagedIdentityReference identity)

Set the identity property: Managed identity properties for the endpoint.

Overrides:

ServiceBus.withIdentity(ManagedIdentityReference identity)

Parameters:

identity

withPrimaryConnectionString

public ServiceBus withPrimaryConnectionString(String primaryConnectionString)

Set the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

Parameters:

primaryConnectionString - the primaryConnectionString value to set.

Returns:

the ServiceBus object itself.

withSecondaryConnectionString

public ServiceBus withSecondaryConnectionString(String secondaryConnectionString)

Set the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

Parameters:

secondaryConnectionString - the secondaryConnectionString value to set.

Returns:

the ServiceBus object itself.