Interface Interactions
public interface Interactions
Resource collection API of Interactions.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new InteractionResourceFormat resource.Gets information about the specified interaction.Gets information about the specified interaction.com.azure.core.http.rest.Response<InteractionResourceFormat>
getByIdWithResponse
(String id, String localeCode, com.azure.core.util.Context context) Gets information about the specified interaction.com.azure.core.http.rest.Response<InteractionResourceFormat>
getWithResponse
(String resourceGroupName, String hubName, String interactionName, String localeCode, com.azure.core.util.Context context) Gets information about the specified interaction.com.azure.core.http.rest.PagedIterable<InteractionResourceFormat>
Gets all interactions in the hub.com.azure.core.http.rest.PagedIterable<InteractionResourceFormat>
listByHub
(String resourceGroupName, String hubName, String localeCode, com.azure.core.util.Context context) Gets all interactions in the hub.suggestRelationshipLinks
(String resourceGroupName, String hubName, String interactionName) Suggests relationships to create relationship links.com.azure.core.http.rest.Response<SuggestRelationshipLinksResponse>
suggestRelationshipLinksWithResponse
(String resourceGroupName, String hubName, String interactionName, com.azure.core.util.Context context) Suggests relationships to create relationship links.
-
Method Details
-
getWithResponse
com.azure.core.http.rest.Response<InteractionResourceFormat> getWithResponse(String resourceGroupName, String hubName, String interactionName, String localeCode, com.azure.core.util.Context context) Gets information about the specified interaction.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.interactionName
- The name of the interaction.localeCode
- Locale of interaction to retrieve, default is en-us.context
- The context to associate with this operation.- Returns:
- information about the specified interaction 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
Gets information about the specified interaction.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.interactionName
- The name of the interaction.- Returns:
- information about the specified interaction.
- 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<InteractionResourceFormat> listByHub(String resourceGroupName, String hubName) Gets all interactions in the hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.- Returns:
- all interactions 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<InteractionResourceFormat> listByHub(String resourceGroupName, String hubName, String localeCode, com.azure.core.util.Context context) Gets all interactions in the hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.localeCode
- Locale of interaction to retrieve, default is en-us.context
- The context to associate with this operation.- Returns:
- all interactions 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.
-
suggestRelationshipLinksWithResponse
com.azure.core.http.rest.Response<SuggestRelationshipLinksResponse> suggestRelationshipLinksWithResponse(String resourceGroupName, String hubName, String interactionName, com.azure.core.util.Context context) Suggests relationships to create relationship links.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.interactionName
- The name of the interaction.context
- The context to associate with this operation.- Returns:
- the response of suggest relationship links operation 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.
-
suggestRelationshipLinks
SuggestRelationshipLinksResponse suggestRelationshipLinks(String resourceGroupName, String hubName, String interactionName) Suggests relationships to create relationship links.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.interactionName
- The name of the interaction.- Returns:
- the response of suggest relationship links 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.
-
getById
Gets information about the specified interaction.- Parameters:
id
- the resource ID.- Returns:
- information about the specified interaction 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<InteractionResourceFormat> getByIdWithResponse(String id, String localeCode, com.azure.core.util.Context context) Gets information about the specified interaction.- Parameters:
id
- the resource ID.localeCode
- Locale of interaction to retrieve, default is en-us.context
- The context to associate with this operation.- Returns:
- information about the specified interaction 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.
-
define
Begins definition for a new InteractionResourceFormat resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new InteractionResourceFormat definition.
-