Chronicle v1 API - Class DashboardChartServiceClient (1.0.0-beta05)

1.0.0-beta05 (latest) 1.0.0-beta04

public abstract class DashboardChartServiceClient

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

DashboardChartService client wrapper, for convenient use.

Inheritance

object > DashboardChartServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

DashboardChartServiceClientImpl

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Remarks

A service providing functionality for managing dashboards' charts.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default DashboardChartService 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 DashboardChartService.DashboardChartServiceClient GrpcClient { get; }

The underlying gRPC DashboardChartService client

Property Value
Type	Description
DashboardChartServiceDashboardChartServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

BatchGetDashboardCharts(BatchGetDashboardChartsRequest, CallSettings)

public virtual BatchGetDashboardChartsResponse BatchGetDashboardCharts(BatchGetDashboardChartsRequest request, CallSettings callSettings = null)

Get dashboard charts in batches.

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

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
BatchGetDashboardChartsRequest request = new BatchGetDashboardChartsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DashboardChartNames =
    {
        DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
    },
};
// Make the request
BatchGetDashboardChartsResponse response = dashboardChartServiceClient.BatchGetDashboardCharts(request);

BatchGetDashboardCharts(InstanceName, IEnumerable<DashboardChartName>, CallSettings)

public virtual BatchGetDashboardChartsResponse BatchGetDashboardCharts(InstanceName parent, IEnumerable<DashboardChartName> names, CallSettings callSettings = null)

Get dashboard charts in batches.

Parameters
Name	Description
parent	InstanceName Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerableDashboardChartName Required. The names of the dashboard charts to get.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BatchGetDashboardChartsResponse	The RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
IEnumerable<DashboardChartName> names = new DashboardChartName[]
{
    DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
BatchGetDashboardChartsResponse response = dashboardChartServiceClient.BatchGetDashboardCharts(parent, names);

BatchGetDashboardCharts(string, IEnumerable<string>, CallSettings)

public virtual BatchGetDashboardChartsResponse BatchGetDashboardCharts(string parent, IEnumerable<string> names, CallSettings callSettings = null)

Get dashboard charts in batches.

Parameters
Name	Description
parent	string Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerablestring Required. The names of the dashboard charts to get.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BatchGetDashboardChartsResponse	The RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
IEnumerable<string> names = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]",
};
// Make the request
BatchGetDashboardChartsResponse response = dashboardChartServiceClient.BatchGetDashboardCharts(parent, names);

BatchGetDashboardChartsAsync(BatchGetDashboardChartsRequest, CallSettings)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(BatchGetDashboardChartsRequest request, CallSettings callSettings = null)

Get dashboard charts in batches.

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

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
BatchGetDashboardChartsRequest request = new BatchGetDashboardChartsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DashboardChartNames =
    {
        DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
    },
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(request);

BatchGetDashboardChartsAsync(BatchGetDashboardChartsRequest, CancellationToken)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(BatchGetDashboardChartsRequest request, CancellationToken cancellationToken)

Get dashboard charts in batches.

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

Returns
Type	Description
TaskBatchGetDashboardChartsResponse	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
BatchGetDashboardChartsRequest request = new BatchGetDashboardChartsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DashboardChartNames =
    {
        DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
    },
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(request);

BatchGetDashboardChartsAsync(InstanceName, IEnumerable<DashboardChartName>, CallSettings)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(InstanceName parent, IEnumerable<DashboardChartName> names, CallSettings callSettings = null)

Get dashboard charts in batches.

Parameters
Name	Description
parent	InstanceName Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerableDashboardChartName Required. The names of the dashboard charts to get.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBatchGetDashboardChartsResponse	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
IEnumerable<DashboardChartName> names = new DashboardChartName[]
{
    DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(parent, names);

BatchGetDashboardChartsAsync(InstanceName, IEnumerable<DashboardChartName>, CancellationToken)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(InstanceName parent, IEnumerable<DashboardChartName> names, CancellationToken cancellationToken)

Get dashboard charts in batches.

Parameters
Name	Description
parent	InstanceName Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerableDashboardChartName Required. The names of the dashboard charts to get.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskBatchGetDashboardChartsResponse	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
IEnumerable<DashboardChartName> names = new DashboardChartName[]
{
    DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(parent, names);

BatchGetDashboardChartsAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(string parent, IEnumerable<string> names, CallSettings callSettings = null)

Get dashboard charts in batches.

Parameters
Name	Description
parent	string Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerablestring Required. The names of the dashboard charts to get.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBatchGetDashboardChartsResponse	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
IEnumerable<string> names = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]",
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(parent, names);

BatchGetDashboardChartsAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<BatchGetDashboardChartsResponse> BatchGetDashboardChartsAsync(string parent, IEnumerable<string> names, CancellationToken cancellationToken)

Get dashboard charts in batches.

Parameters
Name	Description
parent	string Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
names	IEnumerablestring Required. The names of the dashboard charts to get.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskBatchGetDashboardChartsResponse	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
IEnumerable<string> names = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]",
};
// Make the request
BatchGetDashboardChartsResponse response = await dashboardChartServiceClient.BatchGetDashboardChartsAsync(parent, names);

Create()

public static DashboardChartServiceClient Create()

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

Returns
Type	Description
DashboardChartServiceClient	The created DashboardChartServiceClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
TaskDashboardChartServiceClient	The task representing the created DashboardChartServiceClient.

GetDashboardChart(DashboardChartName, CallSettings)

public virtual DashboardChart GetDashboardChart(DashboardChartName name, CallSettings callSettings = null)

Get a dashboard chart.

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

Returns
Type	Description
DashboardChart	The RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
DashboardChartName name = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]");
// Make the request
DashboardChart response = dashboardChartServiceClient.GetDashboardChart(name);

GetDashboardChart(GetDashboardChartRequest, CallSettings)

public virtual DashboardChart GetDashboardChart(GetDashboardChartRequest request, CallSettings callSettings = null)

Get a dashboard chart.

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

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
GetDashboardChartRequest request = new GetDashboardChartRequest
{
    DashboardChartName = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
DashboardChart response = dashboardChartServiceClient.GetDashboardChart(request);

GetDashboardChart(string, CallSettings)

public virtual DashboardChart GetDashboardChart(string name, CallSettings callSettings = null)

Get a dashboard chart.

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

Returns
Type	Description
DashboardChart	The RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = DashboardChartServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]";
// Make the request
DashboardChart response = dashboardChartServiceClient.GetDashboardChart(name);

GetDashboardChartAsync(DashboardChartName, CallSettings)

public virtual Task<DashboardChart> GetDashboardChartAsync(DashboardChartName name, CallSettings callSettings = null)

Get a dashboard chart.

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

Returns
Type	Description
TaskDashboardChart	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
DashboardChartName name = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]");
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(name);

GetDashboardChartAsync(DashboardChartName, CancellationToken)

public virtual Task<DashboardChart> GetDashboardChartAsync(DashboardChartName name, CancellationToken cancellationToken)

Get a dashboard chart.

Parameters
Name	Description
name	DashboardChartName Required. The name of the dashboardChart to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskDashboardChart	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
DashboardChartName name = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]");
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(name);

GetDashboardChartAsync(GetDashboardChartRequest, CallSettings)

public virtual Task<DashboardChart> GetDashboardChartAsync(GetDashboardChartRequest request, CallSettings callSettings = null)

Get a dashboard chart.

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

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
GetDashboardChartRequest request = new GetDashboardChartRequest
{
    DashboardChartName = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(request);

GetDashboardChartAsync(GetDashboardChartRequest, CancellationToken)

public virtual Task<DashboardChart> GetDashboardChartAsync(GetDashboardChartRequest request, CancellationToken cancellationToken)

Get a dashboard chart.

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

Returns
Type	Description
TaskDashboardChart	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
GetDashboardChartRequest request = new GetDashboardChartRequest
{
    DashboardChartName = DashboardChartName.FromProjectLocationInstanceChart("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[CHART]"),
};
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(request);

GetDashboardChartAsync(string, CallSettings)

public virtual Task<DashboardChart> GetDashboardChartAsync(string name, CallSettings callSettings = null)

Get a dashboard chart.

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

Returns
Type	Description
TaskDashboardChart	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]";
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(name);

GetDashboardChartAsync(string, CancellationToken)

public virtual Task<DashboardChart> GetDashboardChartAsync(string name, CancellationToken cancellationToken)

Get a dashboard chart.

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

Returns
Type	Description
TaskDashboardChart	A Task containing the RPC response.

Example

// Create client
DashboardChartServiceClient dashboardChartServiceClient = await DashboardChartServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dashboardCharts/[CHART]";
// Make the request
DashboardChart response = await dashboardChartServiceClient.GetDashboardChartAsync(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.