Show / Hide Table of Contents

Class PrivateAuctionDealServiceClient

PrivateAuctionDealService client wrapper, for convenient use.

Inheritance
object
PrivateAuctionDealServiceClient
PrivateAuctionDealServiceClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public abstract class PrivateAuctionDealServiceClient
Remarks

Provides methods for handling PrivateAuctionDeal objects.

Properties

DefaultEndpoint

The default endpoint for the PrivateAuctionDealService service, which is a host of "admanager.googleapis.com" and a port of 443.

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
string

DefaultScopes

The default PrivateAuctionDealService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default PrivateAuctionDealService scopes are:

  • https://www.googleapis.com/auth/admanager

GrpcClient

The underlying gRPC PrivateAuctionDealService client

Declaration
public virtual PrivateAuctionDealService.PrivateAuctionDealServiceClient GrpcClient { get; }
Property Value
Type Description
PrivateAuctionDealService.PrivateAuctionDealServiceClient

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 PrivateAuctionDealServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PrivateAuctionDealServiceClientBuilder.

Declaration
public static PrivateAuctionDealServiceClient Create()
Returns
Type Description
PrivateAuctionDealServiceClient

The created PrivateAuctionDealServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a PrivateAuctionDealServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PrivateAuctionDealServiceClientBuilder.

Declaration
public static Task<PrivateAuctionDealServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<PrivateAuctionDealServiceClient>

The task representing the created PrivateAuctionDealServiceClient.

CreatePrivateAuctionDeal(CreatePrivateAuctionDealRequest, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal CreatePrivateAuctionDeal(CreatePrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreatePrivateAuctionDealRequest 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
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
CreatePrivateAuctionDealRequest request = new CreatePrivateAuctionDealRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuctionDeal = new PrivateAuctionDeal(),
};
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.CreatePrivateAuctionDeal(request);

CreatePrivateAuctionDeal(NetworkName, PrivateAuctionDeal, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal CreatePrivateAuctionDeal(NetworkName parent, PrivateAuctionDeal privateAuctionDeal, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.CreatePrivateAuctionDeal(parent, privateAuctionDeal);

CreatePrivateAuctionDeal(string, PrivateAuctionDeal, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal CreatePrivateAuctionDeal(string parent, PrivateAuctionDeal privateAuctionDeal, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.CreatePrivateAuctionDeal(parent, privateAuctionDeal);

CreatePrivateAuctionDealAsync(CreatePrivateAuctionDealRequest, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(CreatePrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreatePrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePrivateAuctionDealRequest request = new CreatePrivateAuctionDealRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuctionDeal = new PrivateAuctionDeal(),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(request);

CreatePrivateAuctionDealAsync(CreatePrivateAuctionDealRequest, CancellationToken)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(CreatePrivateAuctionDealRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreatePrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePrivateAuctionDealRequest request = new CreatePrivateAuctionDealRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuctionDeal = new PrivateAuctionDeal(),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(request);

CreatePrivateAuctionDealAsync(NetworkName, PrivateAuctionDeal, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(NetworkName parent, PrivateAuctionDeal privateAuctionDeal, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(parent, privateAuctionDeal);

CreatePrivateAuctionDealAsync(NetworkName, PrivateAuctionDeal, CancellationToken)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(NetworkName parent, PrivateAuctionDeal privateAuctionDeal, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(parent, privateAuctionDeal);

CreatePrivateAuctionDealAsync(string, PrivateAuctionDeal, CallSettings)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(string parent, PrivateAuctionDeal privateAuctionDeal, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(parent, privateAuctionDeal);

CreatePrivateAuctionDealAsync(string, PrivateAuctionDeal, CancellationToken)

API to create a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> CreatePrivateAuctionDealAsync(string parent, PrivateAuctionDeal privateAuctionDeal, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}

PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.CreatePrivateAuctionDealAsync(parent, privateAuctionDeal);

GetPrivateAuctionDeal(GetPrivateAuctionDealRequest, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal GetPrivateAuctionDeal(GetPrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetPrivateAuctionDealRequest 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
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
GetPrivateAuctionDealRequest request = new GetPrivateAuctionDealRequest
{
    PrivateAuctionDealName = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]"),
};
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.GetPrivateAuctionDeal(request);

GetPrivateAuctionDeal(PrivateAuctionDealName, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal GetPrivateAuctionDeal(PrivateAuctionDealName name, CallSettings callSettings = null)
Parameters
Type Name Description
PrivateAuctionDealName name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
PrivateAuctionDealName name = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]");
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.GetPrivateAuctionDeal(name);

GetPrivateAuctionDeal(string, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal GetPrivateAuctionDeal(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctionDeals/[PRIVATE_AUCTION_DEAL]";
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.GetPrivateAuctionDeal(name);

GetPrivateAuctionDealAsync(GetPrivateAuctionDealRequest, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(GetPrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetPrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
GetPrivateAuctionDealRequest request = new GetPrivateAuctionDealRequest
{
    PrivateAuctionDealName = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]"),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(request);

GetPrivateAuctionDealAsync(GetPrivateAuctionDealRequest, CancellationToken)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(GetPrivateAuctionDealRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetPrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
GetPrivateAuctionDealRequest request = new GetPrivateAuctionDealRequest
{
    PrivateAuctionDealName = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]"),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(request);

GetPrivateAuctionDealAsync(PrivateAuctionDealName, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(PrivateAuctionDealName name, CallSettings callSettings = null)
Parameters
Type Name Description
PrivateAuctionDealName name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionDealName name = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]");
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(name);

GetPrivateAuctionDealAsync(PrivateAuctionDealName, CancellationToken)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(PrivateAuctionDealName name, CancellationToken cancellationToken)
Parameters
Type Name Description
PrivateAuctionDealName name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionDealName name = PrivateAuctionDealName.FromNetworkCodePrivateAuctionDeal("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]");
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(name);

GetPrivateAuctionDealAsync(string, CallSettings)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctionDeals/[PRIVATE_AUCTION_DEAL]";
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(name);

GetPrivateAuctionDealAsync(string, CancellationToken)

API to retrieve a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> GetPrivateAuctionDealAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctionDeals/[PRIVATE_AUCTION_DEAL]";
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.GetPrivateAuctionDealAsync(name);

ListPrivateAuctionDeals(ListPrivateAuctionDealsRequest, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDeals(ListPrivateAuctionDealsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListPrivateAuctionDealsRequest 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<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
ListPrivateAuctionDealsRequest request = new ListPrivateAuctionDealsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDeals(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PrivateAuctionDeal 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 (ListPrivateAuctionDealsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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;

ListPrivateAuctionDeals(NetworkName, string, int?, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDeals(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDeals(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PrivateAuctionDeal 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 (ListPrivateAuctionDealsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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;

ListPrivateAuctionDeals(string, string, int?, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDeals(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDeals(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PrivateAuctionDeal 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 (ListPrivateAuctionDealsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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;

ListPrivateAuctionDealsAsync(ListPrivateAuctionDealsRequest, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDealsAsync(ListPrivateAuctionDealsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListPrivateAuctionDealsRequest 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<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable asynchronous sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
ListPrivateAuctionDealsRequest request = new ListPrivateAuctionDealsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDealsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuctionDeal 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((ListPrivateAuctionDealsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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;

ListPrivateAuctionDealsAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDealsAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable asynchronous sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDealsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuctionDeal 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((ListPrivateAuctionDealsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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;

ListPrivateAuctionDealsAsync(string, string, int?, CallSettings)

API to retrieve a list of PrivateAuctionDeal objects.

Declaration
public virtual PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> ListPrivateAuctionDealsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal>

A pageable asynchronous sequence of PrivateAuctionDeal resources.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionDealsResponse, PrivateAuctionDeal> response = privateAuctionDealServiceClient.ListPrivateAuctionDealsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuctionDeal 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((ListPrivateAuctionDealsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuctionDeal 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<PrivateAuctionDeal> 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 (PrivateAuctionDeal 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.

UpdatePrivateAuctionDeal(PrivateAuctionDeal, FieldMask, CallSettings)

API to update a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal UpdatePrivateAuctionDeal(PrivateAuctionDeal privateAuctionDeal, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to update.

The PrivateAuctionDeal's name is used to identify the PrivateAuctionDeal to update.

FieldMask updateMask

Required. The list of fields to update.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.UpdatePrivateAuctionDeal(privateAuctionDeal, updateMask);

UpdatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest, CallSettings)

API to update a PrivateAuctionDeal object.

Declaration
public virtual PrivateAuctionDeal UpdatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdatePrivateAuctionDealRequest 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
PrivateAuctionDeal

The RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = PrivateAuctionDealServiceClient.Create();
// Initialize request argument(s)
UpdatePrivateAuctionDealRequest request = new UpdatePrivateAuctionDealRequest
{
    PrivateAuctionDeal = new PrivateAuctionDeal(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuctionDeal response = privateAuctionDealServiceClient.UpdatePrivateAuctionDeal(request);

UpdatePrivateAuctionDealAsync(PrivateAuctionDeal, FieldMask, CallSettings)

API to update a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> UpdatePrivateAuctionDealAsync(PrivateAuctionDeal privateAuctionDeal, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to update.

The PrivateAuctionDeal's name is used to identify the PrivateAuctionDeal to update.

FieldMask updateMask

Required. The list of fields to update.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.UpdatePrivateAuctionDealAsync(privateAuctionDeal, updateMask);

UpdatePrivateAuctionDealAsync(PrivateAuctionDeal, FieldMask, CancellationToken)

API to update a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> UpdatePrivateAuctionDealAsync(PrivateAuctionDeal privateAuctionDeal, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
PrivateAuctionDeal privateAuctionDeal

Required. The PrivateAuctionDeal to update.

The PrivateAuctionDeal's name is used to identify the PrivateAuctionDeal to update.

FieldMask updateMask

Required. The list of fields to update.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionDeal privateAuctionDeal = new PrivateAuctionDeal();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.UpdatePrivateAuctionDealAsync(privateAuctionDeal, updateMask);

UpdatePrivateAuctionDealAsync(UpdatePrivateAuctionDealRequest, CallSettings)

API to update a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> UpdatePrivateAuctionDealAsync(UpdatePrivateAuctionDealRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdatePrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePrivateAuctionDealRequest request = new UpdatePrivateAuctionDealRequest
{
    PrivateAuctionDeal = new PrivateAuctionDeal(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.UpdatePrivateAuctionDealAsync(request);

UpdatePrivateAuctionDealAsync(UpdatePrivateAuctionDealRequest, CancellationToken)

API to update a PrivateAuctionDeal object.

Declaration
public virtual Task<PrivateAuctionDeal> UpdatePrivateAuctionDealAsync(UpdatePrivateAuctionDealRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdatePrivateAuctionDealRequest 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<PrivateAuctionDeal>

A Task containing the RPC response.

Sample code
// Create client
PrivateAuctionDealServiceClient privateAuctionDealServiceClient = await PrivateAuctionDealServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePrivateAuctionDealRequest request = new UpdatePrivateAuctionDealRequest
{
    PrivateAuctionDeal = new PrivateAuctionDeal(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuctionDeal response = await privateAuctionDealServiceClient.UpdatePrivateAuctionDealAsync(request);
In this article
Back to top Generated by DocFX