public final class EventHub extends DigitalTwinsEndpointResourceProperties
Properties related to EventHub.
  • Constructor Details

    • EventHub

      public EventHub()
  • Method Details

    • connectionStringPrimaryKey

      public String connectionStringPrimaryKey()
      Get the connectionStringPrimaryKey property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Returns:
      the connectionStringPrimaryKey value.
    • withConnectionStringPrimaryKey

      public EventHub withConnectionStringPrimaryKey(String connectionStringPrimaryKey)
      Set the connectionStringPrimaryKey property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Parameters:
      connectionStringPrimaryKey - the connectionStringPrimaryKey value to set.
      Returns:
      the EventHub object itself.
    • connectionStringSecondaryKey

      public String connectionStringSecondaryKey()
      Get the connectionStringSecondaryKey property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Returns:
      the connectionStringSecondaryKey value.
    • withConnectionStringSecondaryKey

      public EventHub withConnectionStringSecondaryKey(String connectionStringSecondaryKey)
      Set the connectionStringSecondaryKey property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Parameters:
      connectionStringSecondaryKey - the connectionStringSecondaryKey value to set.
      Returns:
      the EventHub object itself.
    • endpointUri

      public String endpointUri()
      Get the endpointUri property: The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
      Returns:
      the endpointUri value.
    • withEndpointUri

      public EventHub withEndpointUri(String endpointUri)
      Set the endpointUri property: The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
      Parameters:
      endpointUri - the endpointUri value to set.
      Returns:
      the EventHub object itself.
    • entityPath

      public String entityPath()
      Get the entityPath property: The EventHub name in the EventHub namespace for identity-based authentication.
      Returns:
      the entityPath value.
    • withEntityPath

      public EventHub withEntityPath(String entityPath)
      Set the entityPath property: The EventHub name in the EventHub namespace for identity-based authentication.
      Parameters:
      entityPath - the entityPath value to set.
      Returns:
      the EventHub object itself.
    • withAuthenticationType

      public EventHub 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:
      withAuthenticationType in class DigitalTwinsEndpointResourceProperties
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • withDeadLetterSecret

      public EventHub withDeadLetterSecret(String deadLetterSecret)
      Set the deadLetterSecret property: Dead letter storage secret for key-based authentication. Will be obfuscated during read.
      Overrides:
      withDeadLetterSecret in class DigitalTwinsEndpointResourceProperties
      Parameters:
      deadLetterSecret - the deadLetterSecret value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • withDeadLetterUri

      public EventHub withDeadLetterUri(String deadLetterUri)
      Set the deadLetterUri property: Dead letter storage URL for identity-based authentication.
      Overrides:
      withDeadLetterUri in class DigitalTwinsEndpointResourceProperties
      Parameters:
      deadLetterUri - the deadLetterUri value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class DigitalTwinsEndpointResourceProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.