Package com.azure.resourcemanager.customerinsights.models

Interface Profiles

public interface Profiles
Resource collection API of Profiles.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<ProfileResourceFormat> getWithResponse(String resourceGroupName, String hubName, String profileName, String localeCode, com.azure.core.util.Context context)
      Gets information about the specified profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      localeCode - Locale of profile to retrieve, default is en-us.
      context - The context to associate with this operation.
      Returns:
      information about the specified profile along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      ProfileResourceFormat get(String resourceGroupName, String hubName, String profileName)
      Gets information about the specified profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      Returns:
      information about the specified profile.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String hubName, String profileName)
      Deletes a profile within a hub.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String hubName, String profileName, String localeCode, com.azure.core.util.Context context)
      Deletes a profile within a hub.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      localeCode - Locale of profile to retrieve, default is en-us.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByHub

      com.azure.core.http.rest.PagedIterable<ProfileResourceFormat> listByHub(String resourceGroupName, String hubName)
      Gets all profile in the hub.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      Returns:
      all profile in the hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByHub

      com.azure.core.http.rest.PagedIterable<ProfileResourceFormat> listByHub(String resourceGroupName, String hubName, String localeCode, com.azure.core.util.Context context)
      Gets all profile in the hub.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      localeCode - Locale of profile to retrieve, default is en-us.
      context - The context to associate with this operation.
      Returns:
      all profile in the hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEnrichingKpisWithResponse

      com.azure.core.http.rest.Response<List<KpiDefinition>> getEnrichingKpisWithResponse(String resourceGroupName, String hubName, String profileName, com.azure.core.util.Context context)
      Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      context - The context to associate with this operation.
      Returns:
      the KPIs that enrich the profile Type identified by the supplied name along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEnrichingKpis

      List<KpiDefinition> getEnrichingKpis(String resourceGroupName, String hubName, String profileName)
      Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
      Parameters:
      resourceGroupName - The name of the resource group.
      hubName - The name of the hub.
      profileName - The name of the profile.
      Returns:
      the KPIs that enrich the profile Type identified by the supplied name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      ProfileResourceFormat getById(String id)
      Gets information about the specified profile.
      Parameters:
      id - the resource ID.
      Returns:
      information about the specified profile along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ProfileResourceFormat> getByIdWithResponse(String id, String localeCode, com.azure.core.util.Context context)
      Gets information about the specified profile.
      Parameters:
      id - the resource ID.
      localeCode - Locale of profile to retrieve, default is en-us.
      context - The context to associate with this operation.
      Returns:
      information about the specified profile along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Deletes a profile within a hub.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, String localeCode, com.azure.core.util.Context context)
      Deletes a profile within a hub.
      Parameters:
      id - the resource ID.
      localeCode - Locale of profile to retrieve, default is en-us.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      ProfileResourceFormat.DefinitionStages.Blank define(String name)
      Begins definition for a new ProfileResourceFormat resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new ProfileResourceFormat definition.