Package com.ibm.cloud.platform_services.partner_management.v1

Class PartnerManagement

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.platform_services.partner_management.v1.PartnerManagement

public class PartnerManagement
extends com.ibm.cloud.sdk.core.service.BaseService

The Partner Management APIs enable you to manage the IBM Cloud partner entities and fetch multiple reports in different formats. API Version: 1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_SERVICE_NAME	Default service name used when configuring the `PartnerManagement` client.
static java.lang.String	DEFAULT_SERVICE_URL	Default service endpoint URL.

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor	Description
PartnerManagement(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)	Constructs an instance of the `PartnerManagement` client.

Method Summary

Modifier and Type	Method	Description
com.ibm.cloud.sdk.core.http.ServiceCall<BillingOptionsSummary>	getBillingOptions(GetBillingOptionsOptions getBillingOptionsOptions)	Get customers billing options.
com.ibm.cloud.sdk.core.http.ServiceCall<CreditPoolsReportSummary>	getCreditPoolsReport(GetCreditPoolsReportOptions getCreditPoolsReportOptions)	Get credit pools report.
com.ibm.cloud.sdk.core.http.ServiceCall<PartnerUsageReportSummary>	getResourceUsageReport(GetResourceUsageReportOptions getResourceUsageReportOptions)	Get partner resource usage report.
static PartnerManagement	newInstance()	Class method which constructs an instance of the `PartnerManagement` client.
static PartnerManagement	newInstance(java.lang.String serviceName)	Class method which constructs an instance of the `PartnerManagement` client.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

Default service name used when configuring the `PartnerManagement` client.

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

Default service endpoint URL.

See Also:

Constant Field Values

Constructor Detail

PartnerManagement

public PartnerManagement(java.lang.String serviceName,
                         com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `PartnerManagement` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static PartnerManagement newInstance()

Class method which constructs an instance of the `PartnerManagement` client. The default service name is used to configure the client instance.

Returns:

an instance of the `PartnerManagement` client using external configuration

newInstance

public static PartnerManagement newInstance(java.lang.String serviceName)

Class method which constructs an instance of the `PartnerManagement` client. The specified service name is used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `PartnerManagement` client using external configuration

getResourceUsageReport

public com.ibm.cloud.sdk.core.http.ServiceCall<PartnerUsageReportSummary> getResourceUsageReport(GetResourceUsageReportOptions getResourceUsageReportOptions)

Get partner resource usage report. Returns the summary for the partner for a given month. Partner billing managers are authorized to access this report.

Parameters:

getResourceUsageReportOptions - the GetResourceUsageReportOptions containing the options for the call

Returns:

a ServiceCall with a result of type PartnerUsageReportSummary

getBillingOptions

public com.ibm.cloud.sdk.core.http.ServiceCall<BillingOptionsSummary> getBillingOptions(GetBillingOptionsOptions getBillingOptionsOptions)

Get customers billing options. Returns the billing options for the requested customer for a given month.

Parameters:

getBillingOptionsOptions - the GetBillingOptionsOptions containing the options for the call

Returns:

a ServiceCall with a result of type BillingOptionsSummary

getCreditPoolsReport

public com.ibm.cloud.sdk.core.http.ServiceCall<CreditPoolsReportSummary> getCreditPoolsReport(GetCreditPoolsReportOptions getCreditPoolsReportOptions)

Get credit pools report. Returns the subscription or commitment burn-down reports for the end customers for a given month.

Parameters:

getCreditPoolsReportOptions - the GetCreditPoolsReportOptions containing the options for the call

Returns:

a ServiceCall with a result of type CreditPoolsReportSummary