Dialogflow v3 API - Class ChangelogsClient (2.6.0)

public abstract class ChangelogsClient

Reference documentation and code samples for the Dialogflow v3 API class ChangelogsClient.

Changelogs client wrapper, for convenient use.

Inheritance

object > ChangelogsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ChangelogsClientImpl

Namespace

Google CloudGoogle.Cloud.DialogflowGoogle.Cloud.Dialogflow.CxV3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Changelogs][google.cloud.dialogflow.cx.v3.Changelog].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Changelogs 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 Changelogs scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default Changelogs scopes are:

GrpcClient

public virtual Changelogs.ChangelogsClient GrpcClient { get; }

The underlying gRPC Changelogs client

Property Value
Type	Description
`ChangelogsChangelogsClient`

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 ChangelogsClient Create()

Synchronously creates a ChangelogsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ChangelogsClientBuilder.

Returns
Type	Description
`ChangelogsClient`	The created ChangelogsClient.

CreateAsync(CancellationToken)

public static Task<ChangelogsClient> CreateAsync(CancellationToken cancellationToken = default)

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskChangelogsClient`	The task representing the created ChangelogsClient.

GetChangelog(ChangelogName, CallSettings)

public virtual Changelog GetChangelog(ChangelogName name, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`ChangelogName` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Changelog`	The RPC response.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
ChangelogName name = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
// Make the request
Changelog response = changelogsClient.GetChangelog(name);

GetChangelog(GetChangelogRequest, CallSettings)

public virtual Changelog GetChangelog(GetChangelogRequest request, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`request`	`GetChangelogRequest` 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
`Changelog`	The RPC response.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
GetChangelogRequest request = new GetChangelogRequest
{
    ChangelogName = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]"),
};
// Make the request
Changelog response = changelogsClient.GetChangelog(request);

GetChangelog(string, CallSettings)

public virtual Changelog GetChangelog(string name, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`string` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Changelog`	The RPC response.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/changelogs/[CHANGELOG]";
// Make the request
Changelog response = changelogsClient.GetChangelog(name);

GetChangelogAsync(ChangelogName, CallSettings)

public virtual Task<Changelog> GetChangelogAsync(ChangelogName name, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`ChangelogName` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
ChangelogName name = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(name);

GetChangelogAsync(ChangelogName, CancellationToken)

public virtual Task<Changelog> GetChangelogAsync(ChangelogName name, CancellationToken cancellationToken)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`ChangelogName` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
ChangelogName name = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(name);

GetChangelogAsync(GetChangelogRequest, CallSettings)

public virtual Task<Changelog> GetChangelogAsync(GetChangelogRequest request, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`request`	`GetChangelogRequest` 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
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
GetChangelogRequest request = new GetChangelogRequest
{
    ChangelogName = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]"),
};
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(request);

GetChangelogAsync(GetChangelogRequest, CancellationToken)

public virtual Task<Changelog> GetChangelogAsync(GetChangelogRequest request, CancellationToken cancellationToken)

Retrieves the specified Changelog.

Parameters
Name	Description
`request`	`GetChangelogRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
GetChangelogRequest request = new GetChangelogRequest
{
    ChangelogName = ChangelogName.FromProjectLocationAgentChangelog("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]"),
};
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(request);

GetChangelogAsync(string, CallSettings)

public virtual Task<Changelog> GetChangelogAsync(string name, CallSettings callSettings = null)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`string` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/changelogs/[CHANGELOG]";
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(name);

GetChangelogAsync(string, CancellationToken)

public virtual Task<Changelog> GetChangelogAsync(string name, CancellationToken cancellationToken)

Retrieves the specified Changelog.

Parameters
Name	Description
`name`	`string` Required. The name of the changelog to get. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskChangelog`	A Task containing the RPC response.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/changelogs/[CHANGELOG]";
// Make the request
Changelog response = await changelogsClient.GetChangelogAsync(name);

ListChangelogs(AgentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListChangelogsResponse, Changelog> ListChangelogs(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent containing the changelogs. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListChangelogsResponseChangelog`	A pageable sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogs(parent);

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

ListChangelogs(ListChangelogsRequest, CallSettings)

public virtual PagedEnumerable<ListChangelogsResponse, Changelog> ListChangelogs(ListChangelogsRequest request, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`request`	`ListChangelogsRequest` 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
`PagedEnumerableListChangelogsResponseChangelog`	A pageable sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
ListChangelogsRequest request = new ListChangelogsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogs(request);

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

ListChangelogs(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListChangelogsResponse, Changelog> ListChangelogs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`parent`	`string` Required. The agent containing the changelogs. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListChangelogsResponseChangelog`	A pageable sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = ChangelogsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogs(parent);

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

ListChangelogsAsync(AgentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListChangelogsResponse, Changelog> ListChangelogsAsync(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`parent`	`AgentName` Required. The agent containing the changelogs. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListChangelogsResponseChangelog`	A pageable asynchronous sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogsAsync(parent);

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

ListChangelogsAsync(ListChangelogsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListChangelogsResponse, Changelog> ListChangelogsAsync(ListChangelogsRequest request, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`request`	`ListChangelogsRequest` 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
`PagedAsyncEnumerableListChangelogsResponseChangelog`	A pageable asynchronous sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
ListChangelogsRequest request = new ListChangelogsRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogsAsync(request);

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

ListChangelogsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListChangelogsResponse, Changelog> ListChangelogsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Returns the list of Changelogs.

Parameters
Name	Description
`parent`	`string` Required. The agent containing the changelogs. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListChangelogsResponseChangelog`	A pageable asynchronous sequence of Changelog resources.

Example

// Create client
ChangelogsClient changelogsClient = await ChangelogsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<ListChangelogsResponse, Changelog> response = changelogsClient.ListChangelogsAsync(parent);

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

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.