Chronicle v1 API - Class DashboardQueryServiceClient (1.0.0-beta05)

1.0.0-beta05 (latest) 1.0.0-beta04

public abstract class DashboardQueryServiceClient

Reference documentation and code samples for the Chronicle v1 API class DashboardQueryServiceClient.

DashboardQueryService client wrapper, for convenient use.

Inheritance

object > DashboardQueryServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

DashboardQueryServiceClientImpl

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Remarks

A service providing functionality for managing dashboards' queries.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DashboardQueryService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default DashboardQueryService scopes are:

• https://www.googleapis.com/auth/chronicle
• https://www.googleapis.com/auth/chronicle.readonly
• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual DashboardQueryService.DashboardQueryServiceClient GrpcClient { get; }

The underlying gRPC DashboardQueryService client

Property Value
Type	Description
DashboardQueryServiceDashboardQueryServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static DashboardQueryServiceClient Create()

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

Returns
Type	Description
DashboardQueryServiceClient	The created DashboardQueryServiceClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
TaskDashboardQueryServiceClient	The task representing the created DashboardQueryServiceClient.

ExecuteDashboardQuery(ExecuteDashboardQueryRequest, CallSettings)

public virtual ExecuteDashboardQueryResponse ExecuteDashboardQuery(ExecuteDashboardQueryRequest request, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
request	ExecuteDashboardQueryRequest 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
ExecuteDashboardQueryResponse	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
ExecuteDashboardQueryRequest request = new ExecuteDashboardQueryRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Query = new DashboardQuery(),
    Filters =
    {
        new DashboardFilter(),
    },
    ClearCache = false,
    UsePreviousTimeRange = false,
};
// Make the request
ExecuteDashboardQueryResponse response = dashboardQueryServiceClient.ExecuteDashboardQuery(request);

ExecuteDashboardQuery(InstanceName, DashboardQuery, CallSettings)

public virtual ExecuteDashboardQueryResponse ExecuteDashboardQuery(InstanceName parent, DashboardQuery query, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
parent	InstanceName Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ExecuteDashboardQueryResponse	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = dashboardQueryServiceClient.ExecuteDashboardQuery(parent, query);

ExecuteDashboardQuery(string, DashboardQuery, CallSettings)

public virtual ExecuteDashboardQueryResponse ExecuteDashboardQuery(string parent, DashboardQuery query, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
parent	string Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ExecuteDashboardQueryResponse	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = dashboardQueryServiceClient.ExecuteDashboardQuery(parent, query);

ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest, CallSettings)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest request, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
request	ExecuteDashboardQueryRequest 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
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
ExecuteDashboardQueryRequest request = new ExecuteDashboardQueryRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Query = new DashboardQuery(),
    Filters =
    {
        new DashboardFilter(),
    },
    ClearCache = false,
    UsePreviousTimeRange = false,
};
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(request);

ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest, CancellationToken)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(ExecuteDashboardQueryRequest request, CancellationToken cancellationToken)

Execute a query and return the data.

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

Returns
Type	Description
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
ExecuteDashboardQueryRequest request = new ExecuteDashboardQueryRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Query = new DashboardQuery(),
    Filters =
    {
        new DashboardFilter(),
    },
    ClearCache = false,
    UsePreviousTimeRange = false,
};
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(request);

ExecuteDashboardQueryAsync(InstanceName, DashboardQuery, CallSettings)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(InstanceName parent, DashboardQuery query, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
parent	InstanceName Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(parent, query);

ExecuteDashboardQueryAsync(InstanceName, DashboardQuery, CancellationToken)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(InstanceName parent, DashboardQuery query, CancellationToken cancellationToken)

Execute a query and return the data.

Parameters
Name	Description
parent	InstanceName Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(parent, query);

ExecuteDashboardQueryAsync(string, DashboardQuery, CallSettings)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(string parent, DashboardQuery query, CallSettings callSettings = null)

Execute a query and return the data.

Parameters
Name	Description
parent	string Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(parent, query);

ExecuteDashboardQueryAsync(string, DashboardQuery, CancellationToken)

public virtual Task<ExecuteDashboardQueryResponse> ExecuteDashboardQueryAsync(string parent, DashboardQuery query, CancellationToken cancellationToken)

Execute a query and return the data.

Parameters
Name	Description
parent	string Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance}
query	DashboardQuery Required. The query to execute and get results back for. QueryID or 'query', 'input.time_window' fields will be used. Use 'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard query.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskExecuteDashboardQueryResponse	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DashboardQuery query = new DashboardQuery();
// Make the request
ExecuteDashboardQueryResponse response = await dashboardQueryServiceClient.ExecuteDashboardQueryAsync(parent, query);

GetDashboardQuery(DashboardQueryName, CallSettings)

public virtual DashboardQuery GetDashboardQuery(DashboardQueryName name, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
name	DashboardQueryName Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
DashboardQuery	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
DashboardQueryName name = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]");
// Make the request
DashboardQuery response = dashboardQueryServiceClient.GetDashboardQuery(name);

GetDashboardQuery(GetDashboardQueryRequest, CallSettings)

public virtual DashboardQuery GetDashboardQuery(GetDashboardQueryRequest request, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
request	GetDashboardQueryRequest 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
DashboardQuery	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
GetDashboardQueryRequest request = new GetDashboardQueryRequest
{
    DashboardQueryName = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]"),
};
// Make the request
DashboardQuery response = dashboardQueryServiceClient.GetDashboardQuery(request);

GetDashboardQuery(string, CallSettings)

public virtual DashboardQuery GetDashboardQuery(string name, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
name	string Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
DashboardQuery	The RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = DashboardQueryServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardQueries/[QUERY]";
// Make the request
DashboardQuery response = dashboardQueryServiceClient.GetDashboardQuery(name);

GetDashboardQueryAsync(DashboardQueryName, CallSettings)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(DashboardQueryName name, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
name	DashboardQueryName Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
DashboardQueryName name = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]");
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(name);

GetDashboardQueryAsync(DashboardQueryName, CancellationToken)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(DashboardQueryName name, CancellationToken cancellationToken)

Get a dashboard query.

Parameters
Name	Description
name	DashboardQueryName Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
DashboardQueryName name = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]");
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(name);

GetDashboardQueryAsync(GetDashboardQueryRequest, CallSettings)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(GetDashboardQueryRequest request, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
request	GetDashboardQueryRequest 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
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
GetDashboardQueryRequest request = new GetDashboardQueryRequest
{
    DashboardQueryName = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]"),
};
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(request);

GetDashboardQueryAsync(GetDashboardQueryRequest, CancellationToken)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(GetDashboardQueryRequest request, CancellationToken cancellationToken)

Get a dashboard query.

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

Returns
Type	Description
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
GetDashboardQueryRequest request = new GetDashboardQueryRequest
{
    DashboardQueryName = DashboardQueryName.FromProjectLocationInstanceQuery("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[QUERY]"),
};
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(request);

GetDashboardQueryAsync(string, CallSettings)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(string name, CallSettings callSettings = null)

Get a dashboard query.

Parameters
Name	Description
name	string Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardQueries/[QUERY]";
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(name);

GetDashboardQueryAsync(string, CancellationToken)

public virtual Task<DashboardQuery> GetDashboardQueryAsync(string name, CancellationToken cancellationToken)

Get a dashboard query.

Parameters
Name	Description
name	string Required. The name of the dashboardQuery to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskDashboardQuery	A Task containing the RPC response.

Example

// Create client
DashboardQueryServiceClient dashboardQueryServiceClient = await DashboardQueryServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardQueries/[QUERY]";
// Make the request
DashboardQuery response = await dashboardQueryServiceClient.GetDashboardQueryAsync(name);

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.