Class SharedPrivateLinkResourceProperties


  • public final class SharedPrivateLinkResourceProperties
    extends Object
    Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.
    • Constructor Detail

      • SharedPrivateLinkResourceProperties

        public SharedPrivateLinkResourceProperties()
    • Method Detail

      • privateLinkResourceId

        public String privateLinkResourceId()
        Get the privateLinkResourceId property: The resource id of the resource the shared private link resource is for.
        Returns:
        the privateLinkResourceId value.
      • withPrivateLinkResourceId

        public SharedPrivateLinkResourceProperties withPrivateLinkResourceId​(String privateLinkResourceId)
        Set the privateLinkResourceId property: The resource id of the resource the shared private link resource is for.
        Parameters:
        privateLinkResourceId - the privateLinkResourceId value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • groupId

        public String groupId()
        Get the groupId property: The group id from the provider of resource the shared private link resource is for.
        Returns:
        the groupId value.
      • withGroupId

        public SharedPrivateLinkResourceProperties withGroupId​(String groupId)
        Set the groupId property: The group id from the provider of resource the shared private link resource is for.
        Parameters:
        groupId - the groupId value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • requestMessage

        public String requestMessage()
        Get the requestMessage property: The request message for requesting approval of the shared private link resource.
        Returns:
        the requestMessage value.
      • withRequestMessage

        public SharedPrivateLinkResourceProperties withRequestMessage​(String requestMessage)
        Set the requestMessage property: The request message for requesting approval of the shared private link resource.
        Parameters:
        requestMessage - the requestMessage value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • resourceRegion

        public String resourceRegion()
        Get the resourceRegion property: Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
        Returns:
        the resourceRegion value.
      • withResourceRegion

        public SharedPrivateLinkResourceProperties withResourceRegion​(String resourceRegion)
        Set the resourceRegion property: Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
        Parameters:
        resourceRegion - the resourceRegion value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • status

        public SharedPrivateLinkResourceStatus status()
        Get the status property: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
        Returns:
        the status value.
      • withStatus

        public SharedPrivateLinkResourceProperties withStatus​(SharedPrivateLinkResourceStatus status)
        Set the status property: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
        Parameters:
        status - the status value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • provisioningState

        public SharedPrivateLinkResourceProvisioningState provisioningState()
        Get the provisioningState property: The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
        Returns:
        the provisioningState value.
      • withProvisioningState

        public SharedPrivateLinkResourceProperties withProvisioningState​(SharedPrivateLinkResourceProvisioningState provisioningState)
        Set the provisioningState property: The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
        Parameters:
        provisioningState - the provisioningState value to set.
        Returns:
        the SharedPrivateLinkResourceProperties object itself.
      • validate

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