com.google.api.services.reseller

Class Reseller.Subscriptions.ChangePlan

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.reseller.ResellerRequest<Subscription>

com.google.api.services.reseller.Reseller.Subscriptions.ChangePlan

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Reseller.Subscriptions

public class Reseller.Subscriptions.ChangePlan
extends ResellerRequest<Subscription>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChangePlan(java.lang.String customerId, java.lang.String subscriptionId, ChangePlanRequest content) Update a subscription plan.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomerId() Either the customer's primary domain name or the customer's unique identifier.
java.lang.String	getSubscriptionId() This is a required property.
Reseller.Subscriptions.ChangePlan	set(java.lang.String parameterName, java.lang.Object value)
Reseller.Subscriptions.ChangePlan	setAlt(java.lang.String alt) Data format for the response.
Reseller.Subscriptions.ChangePlan	setCustomerId(java.lang.String customerId) Either the customer's primary domain name or the customer's unique identifier.
Reseller.Subscriptions.ChangePlan	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Reseller.Subscriptions.ChangePlan	setKey(java.lang.String key) API key.
Reseller.Subscriptions.ChangePlan	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Reseller.Subscriptions.ChangePlan	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Reseller.Subscriptions.ChangePlan	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Reseller.Subscriptions.ChangePlan	setSubscriptionId(java.lang.String subscriptionId) This is a required property.
Reseller.Subscriptions.ChangePlan	setUserIp(java.lang.String userIp) Deprecated.

Methods inherited from class com.google.api.services.reseller.ResellerRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ChangePlan

protected ChangePlan(java.lang.String customerId,
                     java.lang.String subscriptionId,
                     ChangePlanRequest content)

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. Create a request for the method "subscriptions.changePlan". This request holds the parameters needed by the the reseller server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Reseller.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

customerId - Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

subscriptionId - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

content - the ChangePlanRequest

Since:

1.13

Method Detail

setAlt

public Reseller.Subscriptions.ChangePlan setAlt(java.lang.String alt)

Description copied from class: ResellerRequest

Data format for the response.

Overrides:

setAlt in class ResellerRequest<Subscription>

setFields

public Reseller.Subscriptions.ChangePlan setFields(java.lang.String fields)

Description copied from class: ResellerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ResellerRequest<Subscription>

setKey

public Reseller.Subscriptions.ChangePlan setKey(java.lang.String key)

Description copied from class: ResellerRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ResellerRequest<Subscription>

setOauthToken

public Reseller.Subscriptions.ChangePlan setOauthToken(java.lang.String oauthToken)

Description copied from class: ResellerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ResellerRequest<Subscription>

setPrettyPrint

public Reseller.Subscriptions.ChangePlan setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: ResellerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ResellerRequest<Subscription>

setQuotaUser

public Reseller.Subscriptions.ChangePlan setQuotaUser(java.lang.String quotaUser)

Description copied from class: ResellerRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ResellerRequest<Subscription>

setUserIp

public Reseller.Subscriptions.ChangePlan setUserIp(java.lang.String userIp)

Description copied from class: ResellerRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ResellerRequest<Subscription>

getCustomerId

public java.lang.String getCustomerId()

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

setCustomerId

public Reseller.Subscriptions.ChangePlan setCustomerId(java.lang.String customerId)

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

getSubscriptionId

public java.lang.String getSubscriptionId()

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

setSubscriptionId

public Reseller.Subscriptions.ChangePlan setSubscriptionId(java.lang.String subscriptionId)

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

set

public Reseller.Subscriptions.ChangePlan set(java.lang.String parameterName,
                                             java.lang.Object value)

Overrides:

set in class ResellerRequest<Subscription>