CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.
Using this service: 1. Resellers and distributors can manage a customer entity. 2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access. 3. Resellers and distributors can manage customer entitlements.
CloudChannelService exposes the following resources: - s: An entity—usually an enterprise—managed by a reseller or distributor.
s: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.
s: An entity that identifies links between distributors and their indirect resellers in a channel. v1
Package
@google-cloud/channel!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of CloudChannelServiceClient.
Parameter
Type | Name | Description |
---|
ClientOptions | opts |
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
---|
gax.GoogleAuth | |
cloudChannelServiceStub
cloudChannelServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
---|
Promise<{
[name: string]: Function;
}> | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
---|
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
---|
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
---|
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
---|
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
---|
(code: string, message: string, warnType?: string) => void | |
Methods
activateEntitlement(request, options)
activateEntitlement(request?: protos.google.cloud.channel.v1.IActivateEntitlementRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IActivateEntitlementRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
activateEntitlement(request, options, callback)
activateEntitlement(request: protos.google.cloud.channel.v1.IActivateEntitlementRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IActivateEntitlementRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
activateEntitlement(request, callback)
activateEntitlement(request: protos.google.cloud.channel.v1.IActivateEntitlementRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IActivateEntitlementRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
cancelEntitlement(request, options)
cancelEntitlement(request?: protos.google.cloud.channel.v1.ICancelEntitlementRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICancelEntitlementRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
cancelEntitlement(request, options, callback)
cancelEntitlement(request: protos.google.cloud.channel.v1.ICancelEntitlementRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICancelEntitlementRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
cancelEntitlement(request, callback)
cancelEntitlement(request: protos.google.cloud.channel.v1.ICancelEntitlementRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICancelEntitlementRequest | request |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeOffer(request, options)
changeOffer(request?: protos.google.cloud.channel.v1.IChangeOfferRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeOfferRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
changeOffer(request, options, callback)
changeOffer(request: protos.google.cloud.channel.v1.IChangeOfferRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeOfferRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeOffer(request, callback)
changeOffer(request: protos.google.cloud.channel.v1.IChangeOfferRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeOfferRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeParameters(request, options)
changeParameters(request?: protos.google.cloud.channel.v1.IChangeParametersRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeParametersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
changeParameters(request, options, callback)
changeParameters(request: protos.google.cloud.channel.v1.IChangeParametersRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeParametersRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeParameters(request, callback)
changeParameters(request: protos.google.cloud.channel.v1.IChangeParametersRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeParametersRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeRenewalSettings(request, options)
changeRenewalSettings(request?: protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
changeRenewalSettings(request, options, callback)
changeRenewalSettings(request: protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
changeRenewalSettings(request, callback)
changeRenewalSettings(request: protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IChangeRenewalSettingsRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
checkActivateEntitlementProgress(name)
checkActivateEntitlementProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by activateEntitlement()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkCancelEntitlementProgress(name)
checkCancelEntitlementProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by cancelEntitlement()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkChangeOfferProgress(name)
checkChangeOfferProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by changeOffer()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkChangeParametersProgress(name)
checkChangeParametersProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by changeParameters()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkChangeRenewalSettingsProgress(name)
checkChangeRenewalSettingsProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by changeRenewalSettings()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkCloudIdentityAccountsExist(request, options)
checkCloudIdentityAccountsExist(request?: protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse,
(protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse,
(protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | undefined),
{} | undefined
]> | |
checkCloudIdentityAccountsExist(request, options, callback)
checkCloudIdentityAccountsExist(request: protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse, protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse, protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
checkCloudIdentityAccountsExist(request, callback)
checkCloudIdentityAccountsExist(request: protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest, callback: Callback<protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse, protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | request |
|
Callback<protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistResponse, protos.google.cloud.channel.v1.ICheckCloudIdentityAccountsExistRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
checkCreateEntitlementProgress(name)
checkCreateEntitlementProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by createEntitlement()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkProvisionCloudIdentityProgress(name)
checkProvisionCloudIdentityProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Customer, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by provisionCloudIdentity()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Customer, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkStartPaidServiceProgress(name)
checkStartPaidServiceProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by startPaidService()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkSuspendEntitlementProgress(name)
checkSuspendEntitlementProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by suspendEntitlement()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.Entitlement, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkTransferEntitlementsProgress(name)
checkTransferEntitlementsProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.TransferEntitlementsResponse, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by transferEntitlements()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.cloud.channel.v1.TransferEntitlementsResponse, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkTransferEntitlementsToGoogleProgress(name)
checkTransferEntitlementsToGoogleProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.channel.v1.OperationMetadata>>;
Check the status of the long running operation returned by transferEntitlementsToGoogle()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.channel.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
---|
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createChannelPartnerLink(request, options)
createChannelPartnerLink(request?: protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
(protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
(protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | undefined),
{} | undefined
]> | |
createChannelPartnerLink(request, options, callback)
createChannelPartnerLink(request: protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
createChannelPartnerLink(request, callback)
createChannelPartnerLink(request: protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | request |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.ICreateChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
createCustomer(request, options)
createCustomer(request?: protos.google.cloud.channel.v1.ICreateCustomerRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.ICreateCustomerRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateCustomerRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.ICreateCustomerRequest | undefined,
{} | undefined
]> | |
createCustomer(request, options, callback)
createCustomer(request: protos.google.cloud.channel.v1.ICreateCustomerRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.ICreateCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateCustomerRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.ICreateCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
createCustomer(request, callback)
createCustomer(request: protos.google.cloud.channel.v1.ICreateCustomerRequest, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.ICreateCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateCustomerRequest | request |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.ICreateCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
createEntitlement(request, options)
createEntitlement(request?: protos.google.cloud.channel.v1.ICreateEntitlementRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateEntitlementRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createEntitlement(request, options, callback)
createEntitlement(request: protos.google.cloud.channel.v1.ICreateEntitlementRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateEntitlementRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
createEntitlement(request, callback)
createEntitlement(request: protos.google.cloud.channel.v1.ICreateEntitlementRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ICreateEntitlementRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
customerPath(account, customer)
customerPath(account: string, customer: string): string;
Return a fully-qualified customer resource name string.
Parameters
Type | Name | Description |
---|
string | account |
|
string | customer |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
deleteCustomer(request, options)
deleteCustomer(request?: protos.google.cloud.channel.v1.IDeleteCustomerRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.channel.v1.IDeleteCustomerRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IDeleteCustomerRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.channel.v1.IDeleteCustomerRequest | undefined,
{} | undefined
]> | |
deleteCustomer(request, options, callback)
deleteCustomer(request: protos.google.cloud.channel.v1.IDeleteCustomerRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IDeleteCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IDeleteCustomerRequest | request |
|
CallOptions | options |
|
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IDeleteCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteCustomer(request, callback)
deleteCustomer(request: protos.google.cloud.channel.v1.IDeleteCustomerRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IDeleteCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IDeleteCustomerRequest | request |
|
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IDeleteCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
entitlementPath(account, customer, entitlement)
entitlementPath(account: string, customer: string, entitlement: string): string;
Return a fully-qualified entitlement resource name string.
Parameters
Type | Name | Description |
---|
string | account |
|
string | customer |
|
string | entitlement |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
getChannelPartnerLink(request, options)
getChannelPartnerLink(request?: protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | undefined,
{} | undefined
]> | |
getChannelPartnerLink(request, options, callback)
getChannelPartnerLink(request: protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getChannelPartnerLink(request, callback)
getChannelPartnerLink(request: protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | request |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IGetChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getCustomer(request, options)
getCustomer(request?: protos.google.cloud.channel.v1.IGetCustomerRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IGetCustomerRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetCustomerRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IGetCustomerRequest | undefined,
{} | undefined
]> | |
getCustomer(request, options, callback)
getCustomer(request: protos.google.cloud.channel.v1.IGetCustomerRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetCustomerRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IGetCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getCustomer(request, callback)
getCustomer(request: protos.google.cloud.channel.v1.IGetCustomerRequest, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetCustomerRequest | request |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IGetCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getEntitlement(request, options)
getEntitlement(request?: protos.google.cloud.channel.v1.IGetEntitlementRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IEntitlement,
protos.google.cloud.channel.v1.IGetEntitlementRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetEntitlementRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IEntitlement,
protos.google.cloud.channel.v1.IGetEntitlementRequest | undefined,
{} | undefined
]> | |
getEntitlement(request, options, callback)
getEntitlement(request: protos.google.cloud.channel.v1.IGetEntitlementRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IGetEntitlementRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetEntitlementRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IGetEntitlementRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getEntitlement(request, callback)
getEntitlement(request: protos.google.cloud.channel.v1.IGetEntitlementRequest, callback: Callback<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IGetEntitlementRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IGetEntitlementRequest | request |
|
Callback<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IGetEntitlementRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
---|
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Type | Name | Description |
---|
Callback<string, undefined, undefined> | callback |
|
Returns
importCustomer(request, options)
importCustomer(request?: protos.google.cloud.channel.v1.IImportCustomerRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IImportCustomerRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IImportCustomerRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IImportCustomerRequest | undefined,
{} | undefined
]> | |
importCustomer(request, options, callback)
importCustomer(request: protos.google.cloud.channel.v1.IImportCustomerRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IImportCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IImportCustomerRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IImportCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
importCustomer(request, callback)
importCustomer(request: protos.google.cloud.channel.v1.IImportCustomerRequest, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IImportCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IImportCustomerRequest | request |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IImportCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type | Description |
---|
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listChannelPartnerLinks(request, options)
listChannelPartnerLinks(request?: protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink[],
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | null,
protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink[],
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | null,
protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse
]> | |
listChannelPartnerLinks(request, options, callback)
listChannelPartnerLinks(request: protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse | null | undefined, protos.google.cloud.channel.v1.IChannelPartnerLink>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse | null | undefined, protos.google.cloud.channel.v1.IChannelPartnerLink> | callback |
|
Returns
listChannelPartnerLinks(request, callback)
listChannelPartnerLinks(request: protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse | null | undefined, protos.google.cloud.channel.v1.IChannelPartnerLink>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, protos.google.cloud.channel.v1.IListChannelPartnerLinksResponse | null | undefined, protos.google.cloud.channel.v1.IChannelPartnerLink> | callback |
|
Returns
listChannelPartnerLinksAsync(request, options)
listChannelPartnerLinksAsync(request?: protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IChannelPartnerLink>;
Equivalent to listChannelPartnerLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IChannelPartnerLink> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ChannelPartnerLink]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listChannelPartnerLinksStream(request, options)
listChannelPartnerLinksStream(request?: protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListChannelPartnerLinksRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [ChannelPartnerLink] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listChannelPartnerLinksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomers(request, options)
listCustomers(request?: protos.google.cloud.channel.v1.IListCustomersRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICustomer[],
protos.google.cloud.channel.v1.IListCustomersRequest | null,
protos.google.cloud.channel.v1.IListCustomersResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListCustomersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICustomer[],
protos.google.cloud.channel.v1.IListCustomersRequest | null,
protos.google.cloud.channel.v1.IListCustomersResponse
]> | |
listCustomers(request, options, callback)
listCustomers(request: protos.google.cloud.channel.v1.IListCustomersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListCustomersRequest, protos.google.cloud.channel.v1.IListCustomersResponse | null | undefined, protos.google.cloud.channel.v1.ICustomer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListCustomersRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListCustomersRequest, protos.google.cloud.channel.v1.IListCustomersResponse | null | undefined, protos.google.cloud.channel.v1.ICustomer> | callback |
|
Returns
listCustomers(request, callback)
listCustomers(request: protos.google.cloud.channel.v1.IListCustomersRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListCustomersRequest, protos.google.cloud.channel.v1.IListCustomersResponse | null | undefined, protos.google.cloud.channel.v1.ICustomer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListCustomersRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListCustomersRequest, protos.google.cloud.channel.v1.IListCustomersResponse | null | undefined, protos.google.cloud.channel.v1.ICustomer> | callback |
|
Returns
listCustomersAsync(request, options)
listCustomersAsync(request?: protos.google.cloud.channel.v1.IListCustomersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.ICustomer>;
Equivalent to listCustomers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListCustomersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.ICustomer> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Customer]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomersStream(request?: protos.google.cloud.channel.v1.IListCustomersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListCustomersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Customer] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCustomersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listEntitlements(request, options)
listEntitlements(request?: protos.google.cloud.channel.v1.IListEntitlementsRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IEntitlement[],
protos.google.cloud.channel.v1.IListEntitlementsRequest | null,
protos.google.cloud.channel.v1.IListEntitlementsResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListEntitlementsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IEntitlement[],
protos.google.cloud.channel.v1.IListEntitlementsRequest | null,
protos.google.cloud.channel.v1.IListEntitlementsResponse
]> | |
listEntitlements(request, options, callback)
listEntitlements(request: protos.google.cloud.channel.v1.IListEntitlementsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListEntitlementsRequest, protos.google.cloud.channel.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.channel.v1.IEntitlement>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListEntitlementsRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListEntitlementsRequest, protos.google.cloud.channel.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.channel.v1.IEntitlement> | callback |
|
Returns
listEntitlements(request, callback)
listEntitlements(request: protos.google.cloud.channel.v1.IListEntitlementsRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListEntitlementsRequest, protos.google.cloud.channel.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.channel.v1.IEntitlement>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListEntitlementsRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListEntitlementsRequest, protos.google.cloud.channel.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.channel.v1.IEntitlement> | callback |
|
Returns
listEntitlementsAsync(request, options)
listEntitlementsAsync(request?: protos.google.cloud.channel.v1.IListEntitlementsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IEntitlement>;
Equivalent to listEntitlements
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListEntitlementsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IEntitlement> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Entitlement]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listEntitlementsStream(request, options)
listEntitlementsStream(request?: protos.google.cloud.channel.v1.IListEntitlementsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListEntitlementsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Entitlement] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEntitlementsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listOffers(request, options)
listOffers(request?: protos.google.cloud.channel.v1.IListOffersRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IOffer[],
protos.google.cloud.channel.v1.IListOffersRequest | null,
protos.google.cloud.channel.v1.IListOffersResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListOffersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IOffer[],
protos.google.cloud.channel.v1.IListOffersRequest | null,
protos.google.cloud.channel.v1.IListOffersResponse
]> | |
listOffers(request, options, callback)
listOffers(request: protos.google.cloud.channel.v1.IListOffersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListOffersRequest, protos.google.cloud.channel.v1.IListOffersResponse | null | undefined, protos.google.cloud.channel.v1.IOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListOffersRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListOffersRequest, protos.google.cloud.channel.v1.IListOffersResponse | null | undefined, protos.google.cloud.channel.v1.IOffer> | callback |
|
Returns
listOffers(request, callback)
listOffers(request: protos.google.cloud.channel.v1.IListOffersRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListOffersRequest, protos.google.cloud.channel.v1.IListOffersResponse | null | undefined, protos.google.cloud.channel.v1.IOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListOffersRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListOffersRequest, protos.google.cloud.channel.v1.IListOffersResponse | null | undefined, protos.google.cloud.channel.v1.IOffer> | callback |
|
Returns
listOffersAsync(request, options)
listOffersAsync(request?: protos.google.cloud.channel.v1.IListOffersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IOffer>;
Equivalent to listOffers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IOffer> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Offer]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listOffersStream(request?: protos.google.cloud.channel.v1.IListOffersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Offer] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOffersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProducts(request, options)
listProducts(request?: protos.google.cloud.channel.v1.IListProductsRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IProduct[],
protos.google.cloud.channel.v1.IListProductsRequest | null,
protos.google.cloud.channel.v1.IListProductsResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListProductsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IProduct[],
protos.google.cloud.channel.v1.IListProductsRequest | null,
protos.google.cloud.channel.v1.IListProductsResponse
]> | |
listProducts(request, options, callback)
listProducts(request: protos.google.cloud.channel.v1.IListProductsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListProductsRequest, protos.google.cloud.channel.v1.IListProductsResponse | null | undefined, protos.google.cloud.channel.v1.IProduct>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListProductsRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListProductsRequest, protos.google.cloud.channel.v1.IListProductsResponse | null | undefined, protos.google.cloud.channel.v1.IProduct> | callback |
|
Returns
listProducts(request, callback)
listProducts(request: protos.google.cloud.channel.v1.IListProductsRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListProductsRequest, protos.google.cloud.channel.v1.IListProductsResponse | null | undefined, protos.google.cloud.channel.v1.IProduct>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListProductsRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListProductsRequest, protos.google.cloud.channel.v1.IListProductsResponse | null | undefined, protos.google.cloud.channel.v1.IProduct> | callback |
|
Returns
listProductsAsync(request, options)
listProductsAsync(request?: protos.google.cloud.channel.v1.IListProductsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IProduct>;
Equivalent to listProducts
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListProductsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IProduct> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Product]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProductsStream(request, options)
listProductsStream(request?: protos.google.cloud.channel.v1.IListProductsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListProductsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Product] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProductsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPurchasableOffers(request, options)
listPurchasableOffers(request?: protos.google.cloud.channel.v1.IListPurchasableOffersRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IPurchasableOffer[],
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | null,
protos.google.cloud.channel.v1.IListPurchasableOffersResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IPurchasableOffer[],
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | null,
protos.google.cloud.channel.v1.IListPurchasableOffersResponse
]> | |
listPurchasableOffers(request, options, callback)
listPurchasableOffers(request: protos.google.cloud.channel.v1.IListPurchasableOffersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableOffersRequest, protos.google.cloud.channel.v1.IListPurchasableOffersResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableOffersRequest, protos.google.cloud.channel.v1.IListPurchasableOffersResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableOffer> | callback |
|
Returns
listPurchasableOffers(request, callback)
listPurchasableOffers(request: protos.google.cloud.channel.v1.IListPurchasableOffersRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableOffersRequest, protos.google.cloud.channel.v1.IListPurchasableOffersResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableOffersRequest, protos.google.cloud.channel.v1.IListPurchasableOffersResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableOffer> | callback |
|
Returns
listPurchasableOffersAsync(request, options)
listPurchasableOffersAsync(request?: protos.google.cloud.channel.v1.IListPurchasableOffersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IPurchasableOffer>;
Equivalent to listPurchasableOffers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IPurchasableOffer> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [PurchasableOffer]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPurchasableOffersStream(request?: protos.google.cloud.channel.v1.IListPurchasableOffersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [PurchasableOffer] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPurchasableOffersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPurchasableSkus(request, options)
listPurchasableSkus(request?: protos.google.cloud.channel.v1.IListPurchasableSkusRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IPurchasableSku[],
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | null,
protos.google.cloud.channel.v1.IListPurchasableSkusResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IPurchasableSku[],
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | null,
protos.google.cloud.channel.v1.IListPurchasableSkusResponse
]> | |
listPurchasableSkus(request, options, callback)
listPurchasableSkus(request: protos.google.cloud.channel.v1.IListPurchasableSkusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableSkusRequest, protos.google.cloud.channel.v1.IListPurchasableSkusResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableSku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableSkusRequest, protos.google.cloud.channel.v1.IListPurchasableSkusResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableSku> | callback |
|
Returns
listPurchasableSkus(request, callback)
listPurchasableSkus(request: protos.google.cloud.channel.v1.IListPurchasableSkusRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableSkusRequest, protos.google.cloud.channel.v1.IListPurchasableSkusResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableSku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListPurchasableSkusRequest, protos.google.cloud.channel.v1.IListPurchasableSkusResponse | null | undefined, protos.google.cloud.channel.v1.IPurchasableSku> | callback |
|
Returns
listPurchasableSkusAsync(request, options)
listPurchasableSkusAsync(request?: protos.google.cloud.channel.v1.IListPurchasableSkusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IPurchasableSku>;
Equivalent to listPurchasableSkus
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.IPurchasableSku> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [PurchasableSku]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPurchasableSkusStream(request, options)
listPurchasableSkusStream(request?: protos.google.cloud.channel.v1.IListPurchasableSkusRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListPurchasableSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [PurchasableSku] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPurchasableSkusAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSkus(request, options)
listSkus(request?: protos.google.cloud.channel.v1.IListSkusRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ISku[],
protos.google.cloud.channel.v1.IListSkusRequest | null,
protos.google.cloud.channel.v1.IListSkusResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSkusRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ISku[],
protos.google.cloud.channel.v1.IListSkusRequest | null,
protos.google.cloud.channel.v1.IListSkusResponse
]> | |
listSkus(request, options, callback)
listSkus(request: protos.google.cloud.channel.v1.IListSkusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListSkusRequest, protos.google.cloud.channel.v1.IListSkusResponse | null | undefined, protos.google.cloud.channel.v1.ISku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSkusRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListSkusRequest, protos.google.cloud.channel.v1.IListSkusResponse | null | undefined, protos.google.cloud.channel.v1.ISku> | callback |
|
Returns
listSkus(request, callback)
listSkus(request: protos.google.cloud.channel.v1.IListSkusRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListSkusRequest, protos.google.cloud.channel.v1.IListSkusResponse | null | undefined, protos.google.cloud.channel.v1.ISku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSkusRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListSkusRequest, protos.google.cloud.channel.v1.IListSkusResponse | null | undefined, protos.google.cloud.channel.v1.ISku> | callback |
|
Returns
listSkusAsync(request, options)
listSkusAsync(request?: protos.google.cloud.channel.v1.IListSkusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.ISku>;
Equivalent to listSkus
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.ISku> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Sku]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSkusStream(request, options)
listSkusStream(request?: protos.google.cloud.channel.v1.IListSkusRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Sku] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSkusAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSubscribers(request, options)
listSubscribers(request?: protos.google.cloud.channel.v1.IListSubscribersRequest, options?: CallOptions): Promise<[
string[],
protos.google.cloud.channel.v1.IListSubscribersRequest | null,
protos.google.cloud.channel.v1.IListSubscribersResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSubscribersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
string[],
protos.google.cloud.channel.v1.IListSubscribersRequest | null,
protos.google.cloud.channel.v1.IListSubscribersResponse
]> | |
listSubscribers(request, options, callback)
listSubscribers(request: protos.google.cloud.channel.v1.IListSubscribersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListSubscribersRequest, protos.google.cloud.channel.v1.IListSubscribersResponse | null | undefined, string>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSubscribersRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListSubscribersRequest, protos.google.cloud.channel.v1.IListSubscribersResponse | null | undefined, string> | callback |
|
Returns
listSubscribers(request, callback)
listSubscribers(request: protos.google.cloud.channel.v1.IListSubscribersRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListSubscribersRequest, protos.google.cloud.channel.v1.IListSubscribersResponse | null | undefined, string>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSubscribersRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListSubscribersRequest, protos.google.cloud.channel.v1.IListSubscribersResponse | null | undefined, string> | callback |
|
Returns
listSubscribersAsync(request, options)
listSubscribersAsync(request?: protos.google.cloud.channel.v1.IListSubscribersRequest, options?: CallOptions): AsyncIterable<string>;
Equivalent to listSubscribers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSubscribersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<string> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing string. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSubscribersStream(request?: protos.google.cloud.channel.v1.IListSubscribersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListSubscribersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing string on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSubscribersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTransferableOffers(request, options)
listTransferableOffers(request?: protos.google.cloud.channel.v1.IListTransferableOffersRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ITransferableOffer[],
protos.google.cloud.channel.v1.IListTransferableOffersRequest | null,
protos.google.cloud.channel.v1.IListTransferableOffersResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableOffersRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ITransferableOffer[],
protos.google.cloud.channel.v1.IListTransferableOffersRequest | null,
protos.google.cloud.channel.v1.IListTransferableOffersResponse
]> | |
listTransferableOffers(request, options, callback)
listTransferableOffers(request: protos.google.cloud.channel.v1.IListTransferableOffersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListTransferableOffersRequest, protos.google.cloud.channel.v1.IListTransferableOffersResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableOffersRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListTransferableOffersRequest, protos.google.cloud.channel.v1.IListTransferableOffersResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableOffer> | callback |
|
Returns
listTransferableOffers(request, callback)
listTransferableOffers(request: protos.google.cloud.channel.v1.IListTransferableOffersRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListTransferableOffersRequest, protos.google.cloud.channel.v1.IListTransferableOffersResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableOffer>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableOffersRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListTransferableOffersRequest, protos.google.cloud.channel.v1.IListTransferableOffersResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableOffer> | callback |
|
Returns
listTransferableOffersAsync(request, options)
listTransferableOffersAsync(request?: protos.google.cloud.channel.v1.IListTransferableOffersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.ITransferableOffer>;
Equivalent to listTransferableOffers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.ITransferableOffer> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [TransferableOffer]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTransferableOffersStream(request?: protos.google.cloud.channel.v1.IListTransferableOffersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableOffersRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [TransferableOffer] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTransferableOffersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTransferableSkus(request, options)
listTransferableSkus(request?: protos.google.cloud.channel.v1.IListTransferableSkusRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ITransferableSku[],
protos.google.cloud.channel.v1.IListTransferableSkusRequest | null,
protos.google.cloud.channel.v1.IListTransferableSkusResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableSkusRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ITransferableSku[],
protos.google.cloud.channel.v1.IListTransferableSkusRequest | null,
protos.google.cloud.channel.v1.IListTransferableSkusResponse
]> | |
listTransferableSkus(request, options, callback)
listTransferableSkus(request: protos.google.cloud.channel.v1.IListTransferableSkusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListTransferableSkusRequest, protos.google.cloud.channel.v1.IListTransferableSkusResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableSku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableSkusRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.cloud.channel.v1.IListTransferableSkusRequest, protos.google.cloud.channel.v1.IListTransferableSkusResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableSku> | callback |
|
Returns
listTransferableSkus(request, callback)
listTransferableSkus(request: protos.google.cloud.channel.v1.IListTransferableSkusRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListTransferableSkusRequest, protos.google.cloud.channel.v1.IListTransferableSkusResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableSku>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableSkusRequest | request |
|
PaginationCallback<protos.google.cloud.channel.v1.IListTransferableSkusRequest, protos.google.cloud.channel.v1.IListTransferableSkusResponse | null | undefined, protos.google.cloud.channel.v1.ITransferableSku> | callback |
|
Returns
listTransferableSkusAsync(request, options)
listTransferableSkusAsync(request?: protos.google.cloud.channel.v1.IListTransferableSkusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.ITransferableSku>;
Equivalent to listTransferableSkus
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.cloud.channel.v1.ITransferableSku> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [TransferableSku]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTransferableSkusStream(request, options)
listTransferableSkusStream(request?: protos.google.cloud.channel.v1.IListTransferableSkusRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IListTransferableSkusRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [TransferableSku] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTransferableSkusAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
lookupOffer(request, options)
lookupOffer(request?: protos.google.cloud.channel.v1.ILookupOfferRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IOffer,
protos.google.cloud.channel.v1.ILookupOfferRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ILookupOfferRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IOffer,
protos.google.cloud.channel.v1.ILookupOfferRequest | undefined,
{} | undefined
]> | |
lookupOffer(request, options, callback)
lookupOffer(request: protos.google.cloud.channel.v1.ILookupOfferRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IOffer, protos.google.cloud.channel.v1.ILookupOfferRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ILookupOfferRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IOffer, protos.google.cloud.channel.v1.ILookupOfferRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
lookupOffer(request, callback)
lookupOffer(request: protos.google.cloud.channel.v1.ILookupOfferRequest, callback: Callback<protos.google.cloud.channel.v1.IOffer, protos.google.cloud.channel.v1.ILookupOfferRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ILookupOfferRequest | request |
|
Callback<protos.google.cloud.channel.v1.IOffer, protos.google.cloud.channel.v1.ILookupOfferRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
matchAccountFromCustomerName(customerName)
matchAccountFromCustomerName(customerName: string): string | number;
Parse the account from Customer resource.
Parameter
Type | Name | Description |
---|
string | customerName |
A fully-qualified path representing Customer resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the account.
|
matchAccountFromEntitlementName(entitlementName)
matchAccountFromEntitlementName(entitlementName: string): string | number;
Parse the account from Entitlement resource.
Parameter
Type | Name | Description |
---|
string | entitlementName |
A fully-qualified path representing Entitlement resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the account.
|
matchAccountFromOfferName(offerName)
matchAccountFromOfferName(offerName: string): string | number;
Parse the account from Offer resource.
Parameter
Type | Name | Description |
---|
string | offerName |
A fully-qualified path representing Offer resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the account.
|
matchCustomerFromCustomerName(customerName)
matchCustomerFromCustomerName(customerName: string): string | number;
Parse the customer from Customer resource.
Parameter
Type | Name | Description |
---|
string | customerName |
A fully-qualified path representing Customer resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the customer.
|
matchCustomerFromEntitlementName(entitlementName)
matchCustomerFromEntitlementName(entitlementName: string): string | number;
Parse the customer from Entitlement resource.
Parameter
Type | Name | Description |
---|
string | entitlementName |
A fully-qualified path representing Entitlement resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the customer.
|
matchEntitlementFromEntitlementName(entitlementName)
matchEntitlementFromEntitlementName(entitlementName: string): string | number;
Parse the entitlement from Entitlement resource.
Parameter
Type | Name | Description |
---|
string | entitlementName |
A fully-qualified path representing Entitlement resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the entitlement.
|
matchOfferFromOfferName(offerName)
matchOfferFromOfferName(offerName: string): string | number;
Parse the offer from Offer resource.
Parameter
Type | Name | Description |
---|
string | offerName |
A fully-qualified path representing Offer resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the offer.
|
matchProductFromProductName(productName)
matchProductFromProductName(productName: string): string | number;
Parse the product from Product resource.
Parameter
Type | Name | Description |
---|
string | productName |
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the product.
|
matchProductFromSkuName(skuName)
matchProductFromSkuName(skuName: string): string | number;
Parse the product from Sku resource.
Parameter
Type | Name | Description |
---|
string | skuName |
A fully-qualified path representing Sku resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the product.
|
matchSkuFromSkuName(skuName)
matchSkuFromSkuName(skuName: string): string | number;
Parse the sku from Sku resource.
Parameter
Type | Name | Description |
---|
string | skuName |
A fully-qualified path representing Sku resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the sku.
|
offerPath(account, offer)
offerPath(account: string, offer: string): string;
Return a fully-qualified offer resource name string.
Parameters
Type | Name | Description |
---|
string | account |
|
string | offer |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
productPath(product)
productPath(product: string): string;
Return a fully-qualified product resource name string.
Parameter
Type | Name | Description |
---|
string | product |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
provisionCloudIdentity(request, options)
provisionCloudIdentity(request?: protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
provisionCloudIdentity(request, options, callback)
provisionCloudIdentity(request: protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
provisionCloudIdentity(request, callback)
provisionCloudIdentity(request: protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IProvisionCloudIdentityRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
registerSubscriber(request, options)
registerSubscriber(request?: protos.google.cloud.channel.v1.IRegisterSubscriberRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IRegisterSubscriberResponse,
protos.google.cloud.channel.v1.IRegisterSubscriberRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IRegisterSubscriberRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IRegisterSubscriberResponse,
protos.google.cloud.channel.v1.IRegisterSubscriberRequest | undefined,
{} | undefined
]> | |
registerSubscriber(request, options, callback)
registerSubscriber(request: protos.google.cloud.channel.v1.IRegisterSubscriberRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IRegisterSubscriberResponse, protos.google.cloud.channel.v1.IRegisterSubscriberRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IRegisterSubscriberRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IRegisterSubscriberResponse, protos.google.cloud.channel.v1.IRegisterSubscriberRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
registerSubscriber(request, callback)
registerSubscriber(request: protos.google.cloud.channel.v1.IRegisterSubscriberRequest, callback: Callback<protos.google.cloud.channel.v1.IRegisterSubscriberResponse, protos.google.cloud.channel.v1.IRegisterSubscriberRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IRegisterSubscriberRequest | request |
|
Callback<protos.google.cloud.channel.v1.IRegisterSubscriberResponse, protos.google.cloud.channel.v1.IRegisterSubscriberRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
skuPath(product, sku)
skuPath(product: string, sku: string): string;
Return a fully-qualified sku resource name string.
Parameters
Type | Name | Description |
---|
string | product |
|
string | sku |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
startPaidService(request, options)
startPaidService(request?: protos.google.cloud.channel.v1.IStartPaidServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IStartPaidServiceRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
startPaidService(request, options, callback)
startPaidService(request: protos.google.cloud.channel.v1.IStartPaidServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IStartPaidServiceRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
startPaidService(request, callback)
startPaidService(request: protos.google.cloud.channel.v1.IStartPaidServiceRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IStartPaidServiceRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
suspendEntitlement(request, options)
suspendEntitlement(request?: protos.google.cloud.channel.v1.ISuspendEntitlementRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ISuspendEntitlementRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
suspendEntitlement(request, options, callback)
suspendEntitlement(request: protos.google.cloud.channel.v1.ISuspendEntitlementRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ISuspendEntitlementRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
suspendEntitlement(request, callback)
suspendEntitlement(request: protos.google.cloud.channel.v1.ISuspendEntitlementRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ISuspendEntitlementRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.IEntitlement, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
transferEntitlements(request, options)
transferEntitlements(request?: protos.google.cloud.channel.v1.ITransferEntitlementsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
transferEntitlements(request, options, callback)
transferEntitlements(request: protos.google.cloud.channel.v1.ITransferEntitlementsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
transferEntitlements(request, callback)
transferEntitlements(request: protos.google.cloud.channel.v1.ITransferEntitlementsRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsRequest | request |
|
Callback<LROperation<protos.google.cloud.channel.v1.ITransferEntitlementsResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
transferEntitlementsToGoogle(request, options)
transferEntitlementsToGoogle(request?: protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
transferEntitlementsToGoogle(request, options, callback)
transferEntitlementsToGoogle(request: protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
transferEntitlementsToGoogle(request, callback)
transferEntitlementsToGoogle(request: protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.ITransferEntitlementsToGoogleRequest | request |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
unregisterSubscriber(request, options)
unregisterSubscriber(request?: protos.google.cloud.channel.v1.IUnregisterSubscriberRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IUnregisterSubscriberResponse,
protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IUnregisterSubscriberResponse,
protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | undefined,
{} | undefined
]> | |
unregisterSubscriber(request, options, callback)
unregisterSubscriber(request: protos.google.cloud.channel.v1.IUnregisterSubscriberRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IUnregisterSubscriberResponse, protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IUnregisterSubscriberResponse, protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
unregisterSubscriber(request, callback)
unregisterSubscriber(request: protos.google.cloud.channel.v1.IUnregisterSubscriberRequest, callback: Callback<protos.google.cloud.channel.v1.IUnregisterSubscriberResponse, protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | request |
|
Callback<protos.google.cloud.channel.v1.IUnregisterSubscriberResponse, protos.google.cloud.channel.v1.IUnregisterSubscriberRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateChannelPartnerLink(request, options)
updateChannelPartnerLink(request?: protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
(protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.IChannelPartnerLink,
(protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | undefined),
{} | undefined
]> | |
updateChannelPartnerLink(request, options, callback)
updateChannelPartnerLink(request: protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateChannelPartnerLink(request, callback)
updateChannelPartnerLink(request: protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest, callback: Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | request |
|
Callback<protos.google.cloud.channel.v1.IChannelPartnerLink, protos.google.cloud.channel.v1.IUpdateChannelPartnerLinkRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateCustomer(request, options)
updateCustomer(request?: protos.google.cloud.channel.v1.IUpdateCustomerRequest, options?: CallOptions): Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IUpdateCustomerRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateCustomerRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.cloud.channel.v1.ICustomer,
protos.google.cloud.channel.v1.IUpdateCustomerRequest | undefined,
{} | undefined
]> | |
updateCustomer(request, options, callback)
updateCustomer(request: protos.google.cloud.channel.v1.IUpdateCustomerRequest, options: CallOptions, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IUpdateCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateCustomerRequest | request |
|
CallOptions | options |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IUpdateCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateCustomer(request, callback)
updateCustomer(request: protos.google.cloud.channel.v1.IUpdateCustomerRequest, callback: Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IUpdateCustomerRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.cloud.channel.v1.IUpdateCustomerRequest | request |
|
Callback<protos.google.cloud.channel.v1.ICustomer, protos.google.cloud.channel.v1.IUpdateCustomerRequest | null | undefined, {} | null | undefined> | callback |
|
Returns