Class LfpStoreServiceClient
LfpStoreService client wrapper, for convenient use.
Namespace: Google.Shopping.Merchant.Lfp.V1Beta
Assembly: Google.Shopping.Merchant.Lfp.V1Beta.dll
Syntax
public abstract class LfpStoreServiceClient
Remarks
Service for a LFP partner to submit local stores for a merchant.
Properties
DefaultEndpoint
The default endpoint for the LfpStoreService service, which is a host of "merchantapi.googleapis.com" and a port of 443.
Declaration
public static string DefaultEndpoint { get; }
Property Value
Type | Description |
---|---|
string |
DefaultScopes
The default LfpStoreService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<string> |
Remarks
The default LfpStoreService scopes are:
- https://www.googleapis.com/auth/content
GrpcClient
The underlying gRPC LfpStoreService client
Declaration
public virtual LfpStoreService.LfpStoreServiceClient GrpcClient { get; }
Property Value
Type | Description |
---|---|
LfpStoreService.LfpStoreServiceClient |
ServiceMetadata
The service metadata associated with this client type.
Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type | Description |
---|---|
ServiceMetadata |
Methods
Create()
Synchronously creates a LfpStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use LfpStoreServiceClientBuilder.
Declaration
public static LfpStoreServiceClient Create()
Returns
Type | Description |
---|---|
LfpStoreServiceClient | The created LfpStoreServiceClient. |
CreateAsync(CancellationToken)
Asynchronously creates a LfpStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use LfpStoreServiceClientBuilder.
Declaration
public static Task<LfpStoreServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
Type | Description |
---|---|
Task<LfpStoreServiceClient> | The task representing the created LfpStoreServiceClient. |
DeleteLfpStore(DeleteLfpStoreRequest, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual void DeleteLfpStore(DeleteLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
DeleteLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
DeleteLfpStoreRequest request = new DeleteLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
lfpStoreServiceClient.DeleteLfpStore(request);
DeleteLfpStore(LfpStoreName, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual void DeleteLfpStore(LfpStoreName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to delete for the target merchant account.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
lfpStoreServiceClient.DeleteLfpStore(name);
DeleteLfpStore(string, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual void DeleteLfpStore(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to delete for the target merchant account.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
lfpStoreServiceClient.DeleteLfpStore(name);
DeleteLfpStoreAsync(DeleteLfpStoreRequest, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(DeleteLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
DeleteLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteLfpStoreRequest request = new DeleteLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(request);
DeleteLfpStoreAsync(DeleteLfpStoreRequest, CancellationToken)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(DeleteLfpStoreRequest request, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
DeleteLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteLfpStoreRequest request = new DeleteLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(request);
DeleteLfpStoreAsync(LfpStoreName, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(LfpStoreName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to delete for the target merchant account.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(name);
DeleteLfpStoreAsync(LfpStoreName, CancellationToken)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(LfpStoreName name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to delete for the target merchant account.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(name);
DeleteLfpStoreAsync(string, CallSettings)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to delete for the target merchant account.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(name);
DeleteLfpStoreAsync(string, CancellationToken)
Deletes a store for a target merchant.
Declaration
public virtual Task DeleteLfpStoreAsync(string name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to delete for the target merchant account.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
await lfpStoreServiceClient.DeleteLfpStoreAsync(name);
GetLfpStore(GetLfpStoreRequest, CallSettings)
Retrieves information about a store.
Declaration
public virtual LfpStore GetLfpStore(GetLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
GetLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
GetLfpStoreRequest request = new GetLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
LfpStore response = lfpStoreServiceClient.GetLfpStore(request);
GetLfpStore(LfpStoreName, CallSettings)
Retrieves information about a store.
Declaration
public virtual LfpStore GetLfpStore(LfpStoreName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to retrieve.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
LfpStore response = lfpStoreServiceClient.GetLfpStore(name);
GetLfpStore(string, CallSettings)
Retrieves information about a store.
Declaration
public virtual LfpStore GetLfpStore(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to retrieve.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
LfpStore response = lfpStoreServiceClient.GetLfpStore(name);
GetLfpStoreAsync(GetLfpStoreRequest, CallSettings)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(GetLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
GetLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetLfpStoreRequest request = new GetLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(request);
GetLfpStoreAsync(GetLfpStoreRequest, CancellationToken)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(GetLfpStoreRequest request, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
GetLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetLfpStoreRequest request = new GetLfpStoreRequest
{
LfpStoreName = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]"),
};
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(request);
GetLfpStoreAsync(LfpStoreName, CallSettings)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(LfpStoreName name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to retrieve.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(name);
GetLfpStoreAsync(LfpStoreName, CancellationToken)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(LfpStoreName name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
LfpStoreName | name | Required. The name of the store to retrieve.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LfpStoreName name = LfpStoreName.FromAccountTargetMerchantStoreCode("[ACCOUNT]", "[TARGET_MERCHANT]", "[STORE_CODE]");
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(name);
GetLfpStoreAsync(string, CallSettings)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(string name, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to retrieve.
Format: |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(name);
GetLfpStoreAsync(string, CancellationToken)
Retrieves information about a store.
Declaration
public virtual Task<LfpStore> GetLfpStoreAsync(string name, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the store to retrieve.
Format: |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/lfpStores/[TARGET_MERCHANT]~[STORE_CODE]";
// Make the request
LfpStore response = await lfpStoreServiceClient.GetLfpStoreAsync(name);
InsertLfpStore(AccountName, LfpStore, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual LfpStore InsertLfpStore(AccountName parent, LfpStore lfpStore, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = lfpStoreServiceClient.InsertLfpStore(parent, lfpStore);
InsertLfpStore(InsertLfpStoreRequest, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual LfpStore InsertLfpStore(InsertLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
InsertLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
InsertLfpStoreRequest request = new InsertLfpStoreRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
LfpStore = new LfpStore(),
};
// Make the request
LfpStore response = lfpStoreServiceClient.InsertLfpStore(request);
InsertLfpStore(string, LfpStore, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual LfpStore InsertLfpStore(string parent, LfpStore lfpStore, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
LfpStore | The RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = lfpStoreServiceClient.InsertLfpStore(parent, lfpStore);
InsertLfpStoreAsync(AccountName, LfpStore, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(AccountName parent, LfpStore lfpStore, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(parent, lfpStore);
InsertLfpStoreAsync(AccountName, LfpStore, CancellationToken)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(AccountName parent, LfpStore lfpStore, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(parent, lfpStore);
InsertLfpStoreAsync(InsertLfpStoreRequest, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(InsertLfpStoreRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
InsertLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
InsertLfpStoreRequest request = new InsertLfpStoreRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
LfpStore = new LfpStore(),
};
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(request);
InsertLfpStoreAsync(InsertLfpStoreRequest, CancellationToken)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(InsertLfpStoreRequest request, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
InsertLfpStoreRequest | request | The request object containing all of the parameters for the API call. |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
InsertLfpStoreRequest request = new InsertLfpStoreRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
LfpStore = new LfpStore(),
};
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(request);
InsertLfpStoreAsync(string, LfpStore, CallSettings)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(string parent, LfpStore lfpStore, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(parent, lfpStore);
InsertLfpStoreAsync(string, LfpStore, CancellationToken)
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
Declaration
public virtual Task<LfpStore> InsertLfpStoreAsync(string parent, LfpStore lfpStore, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The LFP provider account
Format: |
LfpStore | lfpStore | Required. The store to insert. |
CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
Type | Description |
---|---|
Task<LfpStore> | A Task containing the RPC response. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
LfpStore lfpStore = new LfpStore();
// Make the request
LfpStore response = await lfpStoreServiceClient.InsertLfpStoreAsync(parent, lfpStore);
ListLfpStores(AccountName, string, int?, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStores(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The LFP partner.
Format: |
string | pageToken | The token returned from the previous request. A value of |
int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedEnumerable<ListLfpStoresResponse, LfpStore> | A pageable sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStores(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (LfpStore item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListLfpStoresResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListLfpStores(ListLfpStoresRequest, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStores(ListLfpStoresRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
ListLfpStoresRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedEnumerable<ListLfpStoresResponse, LfpStore> | A pageable sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
ListLfpStoresRequest request = new ListLfpStoresRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
TargetAccount = 0L,
};
// Make the request
PagedEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStores(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (LfpStore item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListLfpStoresResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListLfpStores(string, string, int?, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStores(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The LFP partner.
Format: |
string | pageToken | The token returned from the previous request. A value of |
int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedEnumerable<ListLfpStoresResponse, LfpStore> | A pageable sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = LfpStoreServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStores(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (LfpStore item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListLfpStoresResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListLfpStoresAsync(AccountName, string, int?, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStoresAsync(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
AccountName | parent | Required. The LFP partner.
Format: |
string | pageToken | The token returned from the previous request. A value of |
int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> | A pageable asynchronous sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStoresAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((LfpStore item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListLfpStoresResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListLfpStoresAsync(ListLfpStoresRequest, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStoresAsync(ListLfpStoresRequest request, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
ListLfpStoresRequest | request | The request object containing all of the parameters for the API call. |
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> | A pageable asynchronous sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
ListLfpStoresRequest request = new ListLfpStoresRequest
{
ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
TargetAccount = 0L,
};
// Make the request
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStoresAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((LfpStore item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListLfpStoresResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListLfpStoresAsync(string, string, int?, CallSettings)
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
Declaration
public virtual PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> ListLfpStoresAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The LFP partner.
Format: |
string | pageToken | The token returned from the previous request. A value of |
int? | pageSize | The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
Type | Description |
---|---|
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> | A pageable asynchronous sequence of LfpStore resources. |
Sample code
// Create client
LfpStoreServiceClient lfpStoreServiceClient = await LfpStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedAsyncEnumerable<ListLfpStoresResponse, LfpStore> response = lfpStoreServiceClient.ListLfpStoresAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((LfpStore item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListLfpStoresResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (LfpStore item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<LfpStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (LfpStore item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type | Description |
---|---|
Task | A task representing the asynchronous shutdown operation. |
Remarks
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.