public abstract class GeneratorsClient
Reference documentation and code samples for the Google Cloud Dialogflow v2 API class GeneratorsClient.
Generators client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Remarks
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Generators service, which is a host of "dialogflow.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default Generators scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default Generators scopes are:
GrpcClient
public virtual Generators.GeneratorsClient GrpcClient { get; }
The underlying gRPC Generators client
Property Value | |
---|---|
Type | Description |
GeneratorsGeneratorsClient |
LocationsClient
public virtual LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static GeneratorsClient Create()
Synchronously creates a GeneratorsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GeneratorsClientBuilder.
Returns | |
---|---|
Type | Description |
GeneratorsClient |
The created GeneratorsClient. |
CreateAsync(CancellationToken)
public static Task<GeneratorsClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a GeneratorsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GeneratorsClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskGeneratorsClient |
The task representing the created GeneratorsClient. |
CreateGenerator(ProjectName, Generator, string, CallSettings)
public virtual Generator CreateGenerator(ProjectName parent, Generator generator, string generatorId, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = generatorsClient.CreateGenerator(parent, generator, generatorId);
CreateGenerator(CreateGeneratorRequest, CallSettings)
public virtual Generator CreateGenerator(CreateGeneratorRequest request, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
request |
CreateGeneratorRequest 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 |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
CreateGeneratorRequest request = new CreateGeneratorRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
Generator = new Generator(),
GeneratorId = "",
};
// Make the request
Generator response = generatorsClient.CreateGenerator(request);
CreateGenerator(string, Generator, string, CallSettings)
public virtual Generator CreateGenerator(string parent, Generator generator, string generatorId, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = generatorsClient.CreateGenerator(parent, generator, generatorId);
CreateGeneratorAsync(ProjectName, Generator, string, CallSettings)
public virtual Task<Generator> CreateGeneratorAsync(ProjectName parent, Generator generator, string generatorId, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(parent, generator, generatorId);
CreateGeneratorAsync(ProjectName, Generator, string, CancellationToken)
public virtual Task<Generator> CreateGeneratorAsync(ProjectName parent, Generator generator, string generatorId, CancellationToken cancellationToken)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(parent, generator, generatorId);
CreateGeneratorAsync(CreateGeneratorRequest, CallSettings)
public virtual Task<Generator> CreateGeneratorAsync(CreateGeneratorRequest request, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
request |
CreateGeneratorRequest 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 |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
CreateGeneratorRequest request = new CreateGeneratorRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
Generator = new Generator(),
GeneratorId = "",
};
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(request);
CreateGeneratorAsync(CreateGeneratorRequest, CancellationToken)
public virtual Task<Generator> CreateGeneratorAsync(CreateGeneratorRequest request, CancellationToken cancellationToken)
Creates a generator.
Parameters | |
---|---|
Name | Description |
request |
CreateGeneratorRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
CreateGeneratorRequest request = new CreateGeneratorRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
Generator = new Generator(),
GeneratorId = "",
};
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(request);
CreateGeneratorAsync(string, Generator, string, CallSettings)
public virtual Task<Generator> CreateGeneratorAsync(string parent, Generator generator, string generatorId, CallSettings callSettings = null)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(parent, generator, generatorId);
CreateGeneratorAsync(string, Generator, string, CancellationToken)
public virtual Task<Generator> CreateGeneratorAsync(string parent, Generator generator, string generatorId, CancellationToken cancellationToken)
Creates a generator.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project/location to create generator for. Format:
|
generator |
Generator Required. The generator to create. |
generatorId |
string Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Generator generator = new Generator();
string generatorId = "";
// Make the request
Generator response = await generatorsClient.CreateGeneratorAsync(parent, generator, generatorId);
DeleteGenerator(DeleteGeneratorRequest, CallSettings)
public virtual void DeleteGenerator(DeleteGeneratorRequest request, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
request |
DeleteGeneratorRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
DeleteGeneratorRequest request = new DeleteGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
generatorsClient.DeleteGenerator(request);
DeleteGenerator(GeneratorName, CallSettings)
public virtual void DeleteGenerator(GeneratorName name, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to delete. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
generatorsClient.DeleteGenerator(name);
DeleteGenerator(string, CallSettings)
public virtual void DeleteGenerator(string name, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to delete. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
generatorsClient.DeleteGenerator(name);
DeleteGeneratorAsync(DeleteGeneratorRequest, CallSettings)
public virtual Task DeleteGeneratorAsync(DeleteGeneratorRequest request, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
request |
DeleteGeneratorRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
DeleteGeneratorRequest request = new DeleteGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
await generatorsClient.DeleteGeneratorAsync(request);
DeleteGeneratorAsync(DeleteGeneratorRequest, CancellationToken)
public virtual Task DeleteGeneratorAsync(DeleteGeneratorRequest request, CancellationToken cancellationToken)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
request |
DeleteGeneratorRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
DeleteGeneratorRequest request = new DeleteGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
await generatorsClient.DeleteGeneratorAsync(request);
DeleteGeneratorAsync(GeneratorName, CallSettings)
public virtual Task DeleteGeneratorAsync(GeneratorName name, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to delete. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
await generatorsClient.DeleteGeneratorAsync(name);
DeleteGeneratorAsync(GeneratorName, CancellationToken)
public virtual Task DeleteGeneratorAsync(GeneratorName name, CancellationToken cancellationToken)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to delete. Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
await generatorsClient.DeleteGeneratorAsync(name);
DeleteGeneratorAsync(string, CallSettings)
public virtual Task DeleteGeneratorAsync(string name, CallSettings callSettings = null)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to delete. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
await generatorsClient.DeleteGeneratorAsync(name);
DeleteGeneratorAsync(string, CancellationToken)
public virtual Task DeleteGeneratorAsync(string name, CancellationToken cancellationToken)
Deletes a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to delete. Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
await generatorsClient.DeleteGeneratorAsync(name);
GetGenerator(GeneratorName, CallSettings)
public virtual Generator GetGenerator(GeneratorName name, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to retrieve. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
Generator response = generatorsClient.GetGenerator(name);
GetGenerator(GetGeneratorRequest, CallSettings)
public virtual Generator GetGenerator(GetGeneratorRequest request, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
request |
GetGeneratorRequest 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 |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
GetGeneratorRequest request = new GetGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
Generator response = generatorsClient.GetGenerator(request);
GetGenerator(string, CallSettings)
public virtual Generator GetGenerator(string name, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to retrieve. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
Generator response = generatorsClient.GetGenerator(name);
GetGeneratorAsync(GeneratorName, CallSettings)
public virtual Task<Generator> GetGeneratorAsync(GeneratorName name, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to retrieve. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(name);
GetGeneratorAsync(GeneratorName, CancellationToken)
public virtual Task<Generator> GetGeneratorAsync(GeneratorName name, CancellationToken cancellationToken)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
GeneratorName Required. The generator resource name to retrieve. Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GeneratorName name = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]");
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(name);
GetGeneratorAsync(GetGeneratorRequest, CallSettings)
public virtual Task<Generator> GetGeneratorAsync(GetGeneratorRequest request, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
request |
GetGeneratorRequest 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 |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GetGeneratorRequest request = new GetGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(request);
GetGeneratorAsync(GetGeneratorRequest, CancellationToken)
public virtual Task<Generator> GetGeneratorAsync(GetGeneratorRequest request, CancellationToken cancellationToken)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
request |
GetGeneratorRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
GetGeneratorRequest request = new GetGeneratorRequest
{
GeneratorName = GeneratorName.FromProjectLocationGenerator("[PROJECT]", "[LOCATION]", "[GENERATOR]"),
};
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(request);
GetGeneratorAsync(string, CallSettings)
public virtual Task<Generator> GetGeneratorAsync(string name, CallSettings callSettings = null)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to retrieve. Format:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(name);
GetGeneratorAsync(string, CancellationToken)
public virtual Task<Generator> GetGeneratorAsync(string name, CancellationToken cancellationToken)
Retrieves a generator.
Parameters | |
---|---|
Name | Description |
name |
string Required. The generator resource name to retrieve. Format:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/generators/[GENERATOR]";
// Make the request
Generator response = await generatorsClient.GetGeneratorAsync(name);
ListGenerators(ProjectName, string, int?, CallSettings)
public virtual PagedEnumerable<ListGeneratorsResponse, Generator> ListGenerators(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project/location to list generators for. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedEnumerableListGeneratorsResponseGenerator |
A pageable sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGenerators(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Generator 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 (ListGeneratorsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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;
ListGenerators(ListGeneratorsRequest, CallSettings)
public virtual PagedEnumerable<ListGeneratorsResponse, Generator> ListGenerators(ListGeneratorsRequest request, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
request |
ListGeneratorsRequest 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 |
PagedEnumerableListGeneratorsResponseGenerator |
A pageable sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
ListGeneratorsRequest request = new ListGeneratorsRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGenerators(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Generator 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 (ListGeneratorsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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;
ListGenerators(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListGeneratorsResponse, Generator> ListGenerators(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project/location to list generators for. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedEnumerableListGeneratorsResponseGenerator |
A pageable sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGenerators(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Generator 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 (ListGeneratorsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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;
ListGeneratorsAsync(ProjectName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListGeneratorsResponse, Generator> ListGeneratorsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project/location to list generators for. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedAsyncEnumerableListGeneratorsResponseGenerator |
A pageable asynchronous sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGeneratorsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Generator 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((ListGeneratorsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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;
ListGeneratorsAsync(ListGeneratorsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListGeneratorsResponse, Generator> ListGeneratorsAsync(ListGeneratorsRequest request, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
request |
ListGeneratorsRequest 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 |
PagedAsyncEnumerableListGeneratorsResponseGenerator |
A pageable asynchronous sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
ListGeneratorsRequest request = new ListGeneratorsRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedAsyncEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGeneratorsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Generator 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((ListGeneratorsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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;
ListGeneratorsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListGeneratorsResponse, Generator> ListGeneratorsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists generators.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project/location to list generators for. Format:
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedAsyncEnumerableListGeneratorsResponseGenerator |
A pageable asynchronous sequence of Generator resources. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListGeneratorsResponse, Generator> response = generatorsClient.ListGeneratorsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Generator 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((ListGeneratorsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Generator 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<Generator> 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 (Generator 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()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
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.
UpdateGenerator(Generator, FieldMask, CallSettings)
public virtual Generator UpdateGenerator(Generator generator, FieldMask updateMask, CallSettings callSettings = null)
Updates a generator.
Parameters | |
---|---|
Name | Description |
generator |
Generator Required. The generator to update. The name field of generator is to identify the generator to update. |
updateMask |
FieldMask Optional. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
Generator generator = new Generator();
FieldMask updateMask = new FieldMask();
// Make the request
Generator response = generatorsClient.UpdateGenerator(generator, updateMask);
UpdateGenerator(UpdateGeneratorRequest, CallSettings)
public virtual Generator UpdateGenerator(UpdateGeneratorRequest request, CallSettings callSettings = null)
Updates a generator.
Parameters | |
---|---|
Name | Description |
request |
UpdateGeneratorRequest 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 |
Generator |
The RPC response. |
// Create client
GeneratorsClient generatorsClient = GeneratorsClient.Create();
// Initialize request argument(s)
UpdateGeneratorRequest request = new UpdateGeneratorRequest
{
Generator = new Generator(),
UpdateMask = new FieldMask(),
};
// Make the request
Generator response = generatorsClient.UpdateGenerator(request);
UpdateGeneratorAsync(Generator, FieldMask, CallSettings)
public virtual Task<Generator> UpdateGeneratorAsync(Generator generator, FieldMask updateMask, CallSettings callSettings = null)
Updates a generator.
Parameters | |
---|---|
Name | Description |
generator |
Generator Required. The generator to update. The name field of generator is to identify the generator to update. |
updateMask |
FieldMask Optional. The list of fields to update. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
Generator generator = new Generator();
FieldMask updateMask = new FieldMask();
// Make the request
Generator response = await generatorsClient.UpdateGeneratorAsync(generator, updateMask);
UpdateGeneratorAsync(Generator, FieldMask, CancellationToken)
public virtual Task<Generator> UpdateGeneratorAsync(Generator generator, FieldMask updateMask, CancellationToken cancellationToken)
Updates a generator.
Parameters | |
---|---|
Name | Description |
generator |
Generator Required. The generator to update. The name field of generator is to identify the generator to update. |
updateMask |
FieldMask Optional. The list of fields to update. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
Generator generator = new Generator();
FieldMask updateMask = new FieldMask();
// Make the request
Generator response = await generatorsClient.UpdateGeneratorAsync(generator, updateMask);
UpdateGeneratorAsync(UpdateGeneratorRequest, CallSettings)
public virtual Task<Generator> UpdateGeneratorAsync(UpdateGeneratorRequest request, CallSettings callSettings = null)
Updates a generator.
Parameters | |
---|---|
Name | Description |
request |
UpdateGeneratorRequest 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 |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
UpdateGeneratorRequest request = new UpdateGeneratorRequest
{
Generator = new Generator(),
UpdateMask = new FieldMask(),
};
// Make the request
Generator response = await generatorsClient.UpdateGeneratorAsync(request);
UpdateGeneratorAsync(UpdateGeneratorRequest, CancellationToken)
public virtual Task<Generator> UpdateGeneratorAsync(UpdateGeneratorRequest request, CancellationToken cancellationToken)
Updates a generator.
Parameters | |
---|---|
Name | Description |
request |
UpdateGeneratorRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskGenerator |
A Task containing the RPC response. |
// Create client
GeneratorsClient generatorsClient = await GeneratorsClient.CreateAsync();
// Initialize request argument(s)
UpdateGeneratorRequest request = new UpdateGeneratorRequest
{
Generator = new Generator(),
UpdateMask = new FieldMask(),
};
// Make the request
Generator response = await generatorsClient.UpdateGeneratorAsync(request);