CustomDomainConfiguration Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.CustomDomainConfiguration

Implements

JsonSerializable<CustomDomainConfiguration>

public final class CustomDomainConfiguration
implements JsonSerializable<CustomDomainConfiguration>

A custom domain configuration that allows users to publish to their own domain name.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	certificateUrl() Get the certificateUrl property: The URL for the certificate that is used for publishing to the custom domain.
String	expectedTxtRecordName() Get the expectedTxtRecordName property: Expected DNS TXT record name.
String	expectedTxtRecordValue() Get the expectedTxtRecordValue property: Expected DNS TXT record value.
static CustomDomainConfiguration	fromJson(JsonReader jsonReader) Reads an instance of CustomDomainConfiguration from the JsonReader.
String	fullyQualifiedDomainName() Get the fullyQualifiedDomainName property: Fully Qualified Domain Name (FQDN) for the custom domain.
CustomDomainIdentity	identity() Get the identity property: Identity info for accessing the certificate for the custom domain.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
CustomDomainValidationState	validationState() Get the validationState property: Validation state for the custom domain.
CustomDomainConfiguration	withCertificateUrl(String certificateUrl) Set the certificateUrl property: The URL for the certificate that is used for publishing to the custom domain.
CustomDomainConfiguration	withExpectedTxtRecordName(String expectedTxtRecordName) Set the expectedTxtRecordName property: Expected DNS TXT record name.
CustomDomainConfiguration	withExpectedTxtRecordValue(String expectedTxtRecordValue) Set the expectedTxtRecordValue property: Expected DNS TXT record value.
CustomDomainConfiguration	withFullyQualifiedDomainName(String fullyQualifiedDomainName) Set the fullyQualifiedDomainName property: Fully Qualified Domain Name (FQDN) for the custom domain.
CustomDomainConfiguration	withIdentity(CustomDomainIdentity identity) Set the identity property: Identity info for accessing the certificate for the custom domain.
CustomDomainConfiguration	withValidationState(CustomDomainValidationState validationState) Set the validationState property: Validation state for the custom domain.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CustomDomainConfiguration

public CustomDomainConfiguration()

Creates an instance of CustomDomainConfiguration class.

Method Details

certificateUrl

public String certificateUrl()

Get the certificateUrl property: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert).

Returns:

the certificateUrl value.

expectedTxtRecordName

public String expectedTxtRecordName()

Get the expectedTxtRecordName property: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value.

Returns:

the expectedTxtRecordName value.

expectedTxtRecordValue

public String expectedTxtRecordValue()

Get the expectedTxtRecordValue property: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain.

Returns:

the expectedTxtRecordValue value.

fromJson

public static CustomDomainConfiguration fromJson(JsonReader jsonReader)

Reads an instance of CustomDomainConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

Get the fullyQualifiedDomainName property: Fully Qualified Domain Name (FQDN) for the custom domain.

Returns:

the fullyQualifiedDomainName value.

identity

public CustomDomainIdentity identity()

Get the identity property: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace.

Returns:

the identity value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

validationState

public CustomDomainValidationState validationState()

Get the validationState property: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.

Returns:

the validationState value.

withCertificateUrl

public CustomDomainConfiguration withCertificateUrl(String certificateUrl)

Set the certificateUrl property: The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert).

Parameters:

certificateUrl - the certificateUrl value to set.

Returns:

the CustomDomainConfiguration object itself.

withExpectedTxtRecordName

public CustomDomainConfiguration withExpectedTxtRecordName(String expectedTxtRecordName)

Set the expectedTxtRecordName property: Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. The values under this TXT record must contain the expected TXT record value.

Parameters:

expectedTxtRecordName - the expectedTxtRecordName value to set.

Returns:

the CustomDomainConfiguration object itself.

withExpectedTxtRecordValue

public CustomDomainConfiguration withExpectedTxtRecordValue(String expectedTxtRecordValue)

Set the expectedTxtRecordValue property: Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain.

Parameters:

expectedTxtRecordValue - the expectedTxtRecordValue value to set.

Returns:

the CustomDomainConfiguration object itself.

withFullyQualifiedDomainName

public CustomDomainConfiguration withFullyQualifiedDomainName(String fullyQualifiedDomainName)

Set the fullyQualifiedDomainName property: Fully Qualified Domain Name (FQDN) for the custom domain.

Parameters:

fullyQualifiedDomainName - the fullyQualifiedDomainName value to set.

Returns:

the CustomDomainConfiguration object itself.

withIdentity

public CustomDomainConfiguration withIdentity(CustomDomainIdentity identity)

Set the identity property: Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace.

Parameters:

identity - the identity value to set.

Returns:

the CustomDomainConfiguration object itself.

withValidationState

public CustomDomainConfiguration withValidationState(CustomDomainValidationState validationState)

Set the validationState property: Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.

Parameters:

validationState - the validationState value to set.

Returns:

the CustomDomainConfiguration object itself.