DigitalTwinsEndpointResourceProperties 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

Implements

JsonSerializable<DigitalTwinsEndpointResourceProperties>

public class DigitalTwinsEndpointResourceProperties
implements JsonSerializable<DigitalTwinsEndpointResourceProperties>

Properties related to Digital Twins Endpoint.

Constructor Summary

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

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DigitalTwinsEndpointResourceProperties

public DigitalTwinsEndpointResourceProperties()

Creates an instance of DigitalTwinsEndpointResourceProperties class.

Method Details

authenticationType

public AuthenticationType authenticationType()

Get 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.

Returns:

the authenticationType value.

createdTime

public OffsetDateTime createdTime()

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

Returns:

the createdTime value.

deadLetterSecret

public String deadLetterSecret()

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

Returns:

the deadLetterSecret value.

deadLetterUri

public String deadLetterUri()

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

Returns:

the deadLetterUri value.

endpointType

public EndpointType endpointType()

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

Returns:

the endpointType value.

fromJson

public static DigitalTwinsEndpointResourceProperties fromJson(JsonReader jsonReader)

Reads an instance of DigitalTwinsEndpointResourceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DigitalTwinsEndpointResourceProperties 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 DigitalTwinsEndpointResourceProperties.

identity

public ManagedIdentityReference identity()

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

Returns:

the identity value.

provisioningState

public EndpointProvisioningState provisioningState()

Get the provisioningState property: The provisioning state.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAuthenticationType

public DigitalTwinsEndpointResourceProperties 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.

Parameters:

authenticationType - the authenticationType value to set.

Returns:

the DigitalTwinsEndpointResourceProperties object itself.

withDeadLetterSecret

public DigitalTwinsEndpointResourceProperties withDeadLetterSecret(String deadLetterSecret)

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

Parameters:

deadLetterSecret - the deadLetterSecret value to set.

Returns:

the DigitalTwinsEndpointResourceProperties object itself.

withDeadLetterUri

public DigitalTwinsEndpointResourceProperties withDeadLetterUri(String deadLetterUri)

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

Parameters:

deadLetterUri - the deadLetterUri value to set.

Returns:

the DigitalTwinsEndpointResourceProperties object itself.

withIdentity

public DigitalTwinsEndpointResourceProperties withIdentity(ManagedIdentityReference identity)

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

Parameters:

identity - the identity value to set.

Returns:

the DigitalTwinsEndpointResourceProperties object itself.