com.azure.resourcemanager.confidentialledger.fluent.LedgersClient Maven / Gradle / Ivy
Show all versions of azure-resourcemanager-confidentialledger Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.confidentialledger.fluent;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.management.polling.PollResult;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.resourcemanager.confidentialledger.fluent.models.ConfidentialLedgerInner;
/** An instance of this class provides access to all the operations defined in LedgersClient. */
public interface LedgersClient {
/**
* Retrieves information about a Confidential Ledger resource.
*
* Retrieves the properties of a Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getByResourceGroupWithResponse(
String resourceGroupName, String ledgerName, Context context);
/**
* Retrieves information about a Confidential Ledger resource.
*
* Retrieves the properties of a Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfidentialLedgerInner getByResourceGroup(String resourceGroupName, String ledgerName);
/**
* Deletes a Confidential Ledger resource.
*
*
Deletes an existing Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginDelete(String resourceGroupName, String ledgerName);
/**
* Deletes a Confidential Ledger resource.
*
* Deletes an existing Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginDelete(String resourceGroupName, String ledgerName, Context context);
/**
* Deletes a Confidential Ledger resource.
*
* Deletes an existing Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String resourceGroupName, String ledgerName);
/**
* Deletes a Confidential Ledger resource.
*
*
Deletes an existing Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String resourceGroupName, String ledgerName, Context context);
/**
* Creates a Confidential Ledger.
*
*
Creates a Confidential Ledger with the specified ledger parameters.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger Create Request Body.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, ConfidentialLedgerInner> beginCreate(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger);
/**
* Creates a Confidential Ledger.
*
* Creates a Confidential Ledger with the specified ledger parameters.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger Create Request Body.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, ConfidentialLedgerInner> beginCreate(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger, Context context);
/**
* Creates a Confidential Ledger.
*
* Creates a Confidential Ledger with the specified ledger parameters.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger Create Request Body.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfidentialLedgerInner create(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger);
/**
* Creates a Confidential Ledger.
*
*
Creates a Confidential Ledger with the specified ledger parameters.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger Create Request Body.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfidentialLedgerInner create(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger, Context context);
/**
* Update Confidential Ledger properties
*
*
Updates properties of Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger request body for Updating Ledger.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, ConfidentialLedgerInner> beginUpdate(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger);
/**
* Update Confidential Ledger properties
*
* Updates properties of Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger request body for Updating Ledger.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, ConfidentialLedgerInner> beginUpdate(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger, Context context);
/**
* Update Confidential Ledger properties
*
* Updates properties of Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger request body for Updating Ledger.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfidentialLedgerInner update(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger);
/**
* Update Confidential Ledger properties
*
*
Updates properties of Confidential Ledger.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param ledgerName Name of the Confidential Ledger.
* @param confidentialLedger Confidential Ledger request body for Updating Ledger.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return confidential Ledger.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfidentialLedgerInner update(
String resourceGroupName, String ledgerName, ConfidentialLedgerInner confidentialLedger, Context context);
/**
* Retrieves information about all Confidential Ledger resources under the given subscription and resource group
*
*
Retrieves the properties of all Confidential Ledgers.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return object that includes an array of Confidential Ledgers and a possible link for next set as paginated
* response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResourceGroup(String resourceGroupName);
/**
* Retrieves information about all Confidential Ledger resources under the given subscription and resource group
*
* Retrieves the properties of all Confidential Ledgers.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param filter The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return object that includes an array of Confidential Ledgers and a possible link for next set as paginated
* response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResourceGroup(
String resourceGroupName, String filter, Context context);
/**
* Retrieves information about all Confidential Ledger resources under the given subscription
*
* Retrieves the properties of all Confidential Ledgers.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return object that includes an array of Confidential Ledgers and a possible link for next set as paginated
* response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable list();
/**
* Retrieves information about all Confidential Ledger resources under the given subscription
*
* Retrieves the properties of all Confidential Ledgers.
*
* @param filter The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return object that includes an array of Confidential Ledgers and a possible link for next set as paginated
* response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable list(String filter, Context context);
}