Interface BookmarkRelations


  • public interface BookmarkRelations
    Resource collection API of BookmarkRelations.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<Relation> list​(String resourceGroupName,
                                                              String workspaceName,
                                                              String bookmarkId)
        Gets all bookmark relations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        Returns:
        all bookmark relations 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.
      • list

        com.azure.core.http.rest.PagedIterable<Relation> list​(String resourceGroupName,
                                                              String workspaceName,
                                                              String bookmarkId,
                                                              String filter,
                                                              String orderby,
                                                              Integer top,
                                                              String skipToken,
                                                              com.azure.core.util.Context context)
        Gets all bookmark relations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        filter - Filters the results, based on a Boolean condition. Optional.
        orderby - Sorts the results. Optional.
        top - Returns only the first n results. Optional.
        skipToken - Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
        context - The context to associate with this operation.
        Returns:
        all bookmark relations 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.
      • get

        Relation get​(String resourceGroupName,
                     String workspaceName,
                     String bookmarkId,
                     String relationName)
        Gets a bookmark relation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        relationName - Relation Name.
        Returns:
        a bookmark relation.
        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.
      • getWithResponse

        com.azure.core.http.rest.Response<Relation> getWithResponse​(String resourceGroupName,
                                                                    String workspaceName,
                                                                    String bookmarkId,
                                                                    String relationName,
                                                                    com.azure.core.util.Context context)
        Gets a bookmark relation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        relationName - Relation Name.
        context - The context to associate with this operation.
        Returns:
        a bookmark relation 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.
      • delete

        void delete​(String resourceGroupName,
                    String workspaceName,
                    String bookmarkId,
                    String relationName)
        Delete the bookmark relation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        relationName - Relation 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.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String bookmarkId,
                                                                   String relationName,
                                                                   com.azure.core.util.Context context)
        Delete the bookmark relation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - The name of the workspace.
        bookmarkId - Bookmark ID.
        relationName - Relation Name.
        context - The context to associate with this operation.
        Returns:
        the 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.
      • getById

        Relation getById​(String id)
        Gets a bookmark relation.
        Parameters:
        id - the resource ID.
        Returns:
        a bookmark relation 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<Relation> getByIdWithResponse​(String id,
                                                                        com.azure.core.util.Context context)
        Gets a bookmark relation.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        a bookmark relation 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)
        Delete the bookmark relation.
        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

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Delete the bookmark relation.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the 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

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