Class BreakTemplateServiceClient
BreakTemplateService client wrapper, for convenient use.
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public abstract class BreakTemplateServiceClient
Remarks
Provides methods for handling BreakTemplate objects.
Properties
DefaultEndpoint
The default endpoint for the BreakTemplateService 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 BreakTemplateService scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<string> |
Remarks
The default BreakTemplateService scopes are:
- https://www.googleapis.com/auth/admanager
- https://www.googleapis.com/auth/admanager.readonly
GrpcClient
The underlying gRPC BreakTemplateService client
Declaration
public virtual BreakTemplateService.BreakTemplateServiceClient GrpcClient { get; }
Property Value
| Type | Description |
|---|---|
| BreakTemplateService.BreakTemplateServiceClient |
ServiceMetadata
The service metadata associated with this client type.
Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
| Type | Description |
|---|---|
| ServiceMetadata |
Methods
BatchCreateBreakTemplates(BatchCreateBreakTemplatesRequest, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual BatchCreateBreakTemplatesResponse BatchCreateBreakTemplates(BatchCreateBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateBreakTemplatesRequest | 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 |
|---|---|
| BatchCreateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
BatchCreateBreakTemplatesRequest request = new BatchCreateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateBreakTemplateRequest(),
},
};
// Make the request
BatchCreateBreakTemplatesResponse response = breakTemplateServiceClient.BatchCreateBreakTemplates(request);
BatchCreateBreakTemplates(NetworkName, IEnumerable<CreateBreakTemplateRequest>, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual BatchCreateBreakTemplatesResponse BatchCreateBreakTemplates(NetworkName parent, IEnumerable<CreateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchCreateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = breakTemplateServiceClient.BatchCreateBreakTemplates(parent, requests);
BatchCreateBreakTemplates(string, IEnumerable<CreateBreakTemplateRequest>, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual BatchCreateBreakTemplatesResponse BatchCreateBreakTemplates(string parent, IEnumerable<CreateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchCreateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = breakTemplateServiceClient.BatchCreateBreakTemplates(parent, requests);
BatchCreateBreakTemplatesAsync(BatchCreateBreakTemplatesRequest, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(BatchCreateBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateBreakTemplatesRequest | 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<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateBreakTemplatesRequest request = new BatchCreateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateBreakTemplateRequest(),
},
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(request);
BatchCreateBreakTemplatesAsync(BatchCreateBreakTemplatesRequest, CancellationToken)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(BatchCreateBreakTemplatesRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateBreakTemplatesRequest | 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<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateBreakTemplatesRequest request = new BatchCreateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new CreateBreakTemplateRequest(),
},
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(request);
BatchCreateBreakTemplatesAsync(NetworkName, IEnumerable<CreateBreakTemplateRequest>, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(NetworkName parent, IEnumerable<CreateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(parent, requests);
BatchCreateBreakTemplatesAsync(NetworkName, IEnumerable<CreateBreakTemplateRequest>, CancellationToken)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(NetworkName parent, IEnumerable<CreateBreakTemplateRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(parent, requests);
BatchCreateBreakTemplatesAsync(string, IEnumerable<CreateBreakTemplateRequest>, CallSettings)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(string parent, IEnumerable<CreateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(parent, requests);
BatchCreateBreakTemplatesAsync(string, IEnumerable<CreateBreakTemplateRequest>, CancellationToken)
Batch creates BreakTemplate objects.
Declaration
public virtual Task<BatchCreateBreakTemplatesResponse> BatchCreateBreakTemplatesAsync(string parent, IEnumerable<CreateBreakTemplateRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<CreateBreakTemplateRequest> | requests | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateBreakTemplateRequest> requests = new CreateBreakTemplateRequest[]
{
new CreateBreakTemplateRequest(),
};
// Make the request
BatchCreateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchCreateBreakTemplatesAsync(parent, requests);
BatchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual BatchUpdateBreakTemplatesResponse BatchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateBreakTemplatesRequest | 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 |
|---|---|
| BatchUpdateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
BatchUpdateBreakTemplatesRequest request = new BatchUpdateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateBreakTemplateRequest(),
},
};
// Make the request
BatchUpdateBreakTemplatesResponse response = breakTemplateServiceClient.BatchUpdateBreakTemplates(request);
BatchUpdateBreakTemplates(NetworkName, IEnumerable<UpdateBreakTemplateRequest>, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual BatchUpdateBreakTemplatesResponse BatchUpdateBreakTemplates(NetworkName parent, IEnumerable<UpdateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchUpdateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = breakTemplateServiceClient.BatchUpdateBreakTemplates(parent, requests);
BatchUpdateBreakTemplates(string, IEnumerable<UpdateBreakTemplateRequest>, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual BatchUpdateBreakTemplatesResponse BatchUpdateBreakTemplates(string parent, IEnumerable<UpdateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchUpdateBreakTemplatesResponse | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = breakTemplateServiceClient.BatchUpdateBreakTemplates(parent, requests);
BatchUpdateBreakTemplatesAsync(BatchUpdateBreakTemplatesRequest, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(BatchUpdateBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateBreakTemplatesRequest | 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<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateBreakTemplatesRequest request = new BatchUpdateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateBreakTemplateRequest(),
},
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(request);
BatchUpdateBreakTemplatesAsync(BatchUpdateBreakTemplatesRequest, CancellationToken)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(BatchUpdateBreakTemplatesRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateBreakTemplatesRequest | 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<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateBreakTemplatesRequest request = new BatchUpdateBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Requests =
{
new UpdateBreakTemplateRequest(),
},
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(request);
BatchUpdateBreakTemplatesAsync(NetworkName, IEnumerable<UpdateBreakTemplateRequest>, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(NetworkName parent, IEnumerable<UpdateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(parent, requests);
BatchUpdateBreakTemplatesAsync(NetworkName, IEnumerable<UpdateBreakTemplateRequest>, CancellationToken)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(NetworkName parent, IEnumerable<UpdateBreakTemplateRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(parent, requests);
BatchUpdateBreakTemplatesAsync(string, IEnumerable<UpdateBreakTemplateRequest>, CallSettings)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(string parent, IEnumerable<UpdateBreakTemplateRequest> requests, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(parent, requests);
BatchUpdateBreakTemplatesAsync(string, IEnumerable<UpdateBreakTemplateRequest>, CancellationToken)
Batch updates BreakTemplate objects.
Declaration
public virtual Task<BatchUpdateBreakTemplatesResponse> BatchUpdateBreakTemplatesAsync(string parent, IEnumerable<UpdateBreakTemplateRequest> requests, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where |
| IEnumerable<UpdateBreakTemplateRequest> | requests | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateBreakTemplatesResponse> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateBreakTemplateRequest> requests = new UpdateBreakTemplateRequest[]
{
new UpdateBreakTemplateRequest(),
};
// Make the request
BatchUpdateBreakTemplatesResponse response = await breakTemplateServiceClient.BatchUpdateBreakTemplatesAsync(parent, requests);
Create()
Synchronously creates a BreakTemplateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BreakTemplateServiceClientBuilder.
Declaration
public static BreakTemplateServiceClient Create()
Returns
| Type | Description |
|---|---|
| BreakTemplateServiceClient | The created BreakTemplateServiceClient. |
CreateAsync(CancellationToken)
Asynchronously creates a BreakTemplateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BreakTemplateServiceClientBuilder.
Declaration
public static Task<BreakTemplateServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | The CancellationToken to use while creating the client. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplateServiceClient> | The task representing the created BreakTemplateServiceClient. |
CreateBreakTemplate(CreateBreakTemplateRequest, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual BreakTemplate CreateBreakTemplate(CreateBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateBreakTemplateRequest | 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 |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
CreateBreakTemplateRequest request = new CreateBreakTemplateRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
BreakTemplate = new BreakTemplate(),
};
// Make the request
BreakTemplate response = breakTemplateServiceClient.CreateBreakTemplate(request);
CreateBreakTemplate(NetworkName, BreakTemplate, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual BreakTemplate CreateBreakTemplate(NetworkName parent, BreakTemplate breakTemplate, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = breakTemplateServiceClient.CreateBreakTemplate(parent, breakTemplate);
CreateBreakTemplate(string, BreakTemplate, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual BreakTemplate CreateBreakTemplate(string parent, BreakTemplate breakTemplate, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = breakTemplateServiceClient.CreateBreakTemplate(parent, breakTemplate);
CreateBreakTemplateAsync(CreateBreakTemplateRequest, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(CreateBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
CreateBreakTemplateRequest request = new CreateBreakTemplateRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
BreakTemplate = new BreakTemplate(),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(request);
CreateBreakTemplateAsync(CreateBreakTemplateRequest, CancellationToken)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(CreateBreakTemplateRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
CreateBreakTemplateRequest request = new CreateBreakTemplateRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
BreakTemplate = new BreakTemplate(),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(request);
CreateBreakTemplateAsync(NetworkName, BreakTemplate, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(NetworkName parent, BreakTemplate breakTemplate, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(parent, breakTemplate);
CreateBreakTemplateAsync(NetworkName, BreakTemplate, CancellationToken)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(NetworkName parent, BreakTemplate breakTemplate, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| NetworkName | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(parent, breakTemplate);
CreateBreakTemplateAsync(string, BreakTemplate, CallSettings)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(string parent, BreakTemplate breakTemplate, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(parent, breakTemplate);
CreateBreakTemplateAsync(string, BreakTemplate, CancellationToken)
Creates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> CreateBreakTemplateAsync(string parent, BreakTemplate breakTemplate, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource where this |
| BreakTemplate | breakTemplate | Required. The |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
BreakTemplate breakTemplate = new BreakTemplate();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.CreateBreakTemplateAsync(parent, breakTemplate);
GetBreakTemplate(BreakTemplateName, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual BreakTemplate GetBreakTemplate(BreakTemplateName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplateName | name | Required. The resource name of the |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
BreakTemplateName name = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]");
// Make the request
BreakTemplate response = breakTemplateServiceClient.GetBreakTemplate(name);
GetBreakTemplate(GetBreakTemplateRequest, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual BreakTemplate GetBreakTemplate(GetBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetBreakTemplateRequest | 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 |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
GetBreakTemplateRequest request = new GetBreakTemplateRequest
{
BreakTemplateName = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]"),
};
// Make the request
BreakTemplate response = breakTemplateServiceClient.GetBreakTemplate(request);
GetBreakTemplate(string, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual BreakTemplate GetBreakTemplate(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/breakTemplates/[BREAK_TEMPLATE]";
// Make the request
BreakTemplate response = breakTemplateServiceClient.GetBreakTemplate(name);
GetBreakTemplateAsync(BreakTemplateName, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(BreakTemplateName name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplateName | name | Required. The resource name of the |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BreakTemplateName name = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]");
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(name);
GetBreakTemplateAsync(BreakTemplateName, CancellationToken)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(BreakTemplateName name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplateName | name | Required. The resource name of the |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BreakTemplateName name = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]");
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(name);
GetBreakTemplateAsync(GetBreakTemplateRequest, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(GetBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
GetBreakTemplateRequest request = new GetBreakTemplateRequest
{
BreakTemplateName = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]"),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(request);
GetBreakTemplateAsync(GetBreakTemplateRequest, CancellationToken)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(GetBreakTemplateRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| GetBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
GetBreakTemplateRequest request = new GetBreakTemplateRequest
{
BreakTemplateName = BreakTemplateName.FromNetworkCodeBreakTemplate("[NETWORK_CODE]", "[BREAK_TEMPLATE]"),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(request);
GetBreakTemplateAsync(string, CallSettings)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(string name, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/breakTemplates/[BREAK_TEMPLATE]";
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(name);
GetBreakTemplateAsync(string, CancellationToken)
Retrieves a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> GetBreakTemplateAsync(string name, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The resource name of the |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/breakTemplates/[BREAK_TEMPLATE]";
// Make the request
BreakTemplate response = await breakTemplateServiceClient.GetBreakTemplateAsync(name);
ListBreakTemplates(ListBreakTemplatesRequest, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplates(ListBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListBreakTemplatesRequest | 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
ListBreakTemplatesRequest request = new ListBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Filter = "",
OrderBy = "",
Skip = 0,
};
// Make the request
PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplates(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (BreakTemplate 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 (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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;
ListBreakTemplates(NetworkName, string, int?, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplates(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 |
| 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplates(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (BreakTemplate 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 (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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;
ListBreakTemplates(string, string, int?, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplates(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 |
| 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplates(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (BreakTemplate 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 (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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;
ListBreakTemplatesAsync(ListBreakTemplatesRequest, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplatesAsync(ListBreakTemplatesRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListBreakTemplatesRequest | 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable asynchronous sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
ListBreakTemplatesRequest request = new ListBreakTemplatesRequest
{
ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
Filter = "",
OrderBy = "",
Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplatesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (BreakTemplate item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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;
ListBreakTemplatesAsync(NetworkName, string, int?, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplatesAsync(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 |
| 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable asynchronous sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplatesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (BreakTemplate item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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;
ListBreakTemplatesAsync(string, string, int?, CallSettings)
Lists BreakTemplate objects.
Declaration
public virtual PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> ListBreakTemplatesAsync(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 |
| 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<ListBreakTemplatesResponse, BreakTemplate> | A pageable asynchronous sequence of BreakTemplate resources. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListBreakTemplatesResponse, BreakTemplate> response = breakTemplateServiceClient.ListBreakTemplatesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await foreach (BreakTemplate item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListBreakTemplatesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (BreakTemplate 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<BreakTemplate> 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 (BreakTemplate 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.
UpdateBreakTemplate(BreakTemplate, FieldMask, CallSettings)
Updates a BreakTemplate object.
Declaration
public virtual BreakTemplate UpdateBreakTemplate(BreakTemplate breakTemplate, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplate | breakTemplate | Required. The The |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
BreakTemplate breakTemplate = new BreakTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
BreakTemplate response = breakTemplateServiceClient.UpdateBreakTemplate(breakTemplate, updateMask);
UpdateBreakTemplate(UpdateBreakTemplateRequest, CallSettings)
Updates a BreakTemplate object.
Declaration
public virtual BreakTemplate UpdateBreakTemplate(UpdateBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateBreakTemplateRequest | 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 |
|---|---|
| BreakTemplate | The RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = BreakTemplateServiceClient.Create();
// Initialize request argument(s)
UpdateBreakTemplateRequest request = new UpdateBreakTemplateRequest
{
BreakTemplate = new BreakTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
BreakTemplate response = breakTemplateServiceClient.UpdateBreakTemplate(request);
UpdateBreakTemplateAsync(BreakTemplate, FieldMask, CallSettings)
Updates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> UpdateBreakTemplateAsync(BreakTemplate breakTemplate, FieldMask updateMask, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplate | breakTemplate | Required. The The |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BreakTemplate breakTemplate = new BreakTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.UpdateBreakTemplateAsync(breakTemplate, updateMask);
UpdateBreakTemplateAsync(BreakTemplate, FieldMask, CancellationToken)
Updates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> UpdateBreakTemplateAsync(BreakTemplate breakTemplate, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| BreakTemplate | breakTemplate | Required. The The |
| FieldMask | updateMask | Optional. The list of fields to update. |
| CancellationToken | cancellationToken | A CancellationToken to use for this RPC. |
Returns
| Type | Description |
|---|---|
| Task<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
BreakTemplate breakTemplate = new BreakTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
BreakTemplate response = await breakTemplateServiceClient.UpdateBreakTemplateAsync(breakTemplate, updateMask);
UpdateBreakTemplateAsync(UpdateBreakTemplateRequest, CallSettings)
Updates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> UpdateBreakTemplateAsync(UpdateBreakTemplateRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateBreakTemplateRequest request = new UpdateBreakTemplateRequest
{
BreakTemplate = new BreakTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.UpdateBreakTemplateAsync(request);
UpdateBreakTemplateAsync(UpdateBreakTemplateRequest, CancellationToken)
Updates a BreakTemplate object.
Declaration
public virtual Task<BreakTemplate> UpdateBreakTemplateAsync(UpdateBreakTemplateRequest request, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateBreakTemplateRequest | 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<BreakTemplate> | A Task containing the RPC response. |
Sample code
// Create client
BreakTemplateServiceClient breakTemplateServiceClient = await BreakTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateBreakTemplateRequest request = new UpdateBreakTemplateRequest
{
BreakTemplate = new BreakTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
BreakTemplate response = await breakTemplateServiceClient.UpdateBreakTemplateAsync(request);