AgreementsClient Interface

public interface AgreementsClient

An instance of this class provides access to all the operations defined in AgreementsClient.

Method Summary

Modifier and Type Method and Description
abstract AgreementInner get(String billingAccountName, String agreementName)

Gets an agreement by ID.

abstract Response<AgreementInner> getWithResponse(String billingAccountName, String agreementName, Context context)

Gets an agreement by ID.

abstract PagedIterable<AgreementInner> listByBillingAccount(String billingAccountName)

Lists the agreements for a billing account.

abstract PagedIterable<AgreementInner> listByBillingAccount(String billingAccountName, String expand, Context context)

Lists the agreements for a billing account.

Method Details

get

public abstract AgreementInner get(String billingAccountName, String agreementName)

Gets an agreement by ID.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
agreementName - The ID that uniquely identifies an agreement.

Returns:

an agreement by ID.

getWithResponse

public abstract Response<AgreementInner> getWithResponse(String billingAccountName, String agreementName, Context context)

Gets an agreement by ID.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
agreementName - The ID that uniquely identifies an agreement.
context - The context to associate with this operation.

Returns:

an agreement by ID along with Response<T>.

listByBillingAccount

public abstract PagedIterable<AgreementInner> listByBillingAccount(String billingAccountName)

Lists the agreements for a billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByBillingAccount

public abstract PagedIterable<AgreementInner> listByBillingAccount(String billingAccountName, String expand, Context context)

Lists the agreements for a billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
expand - May be used to expand the participants.
context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

Applies to