Developer Connect v1 API - Class InsightsConfigServiceClient (1.0.0-beta02)

public abstract class InsightsConfigServiceClient

Reference documentation and code samples for the Developer Connect v1 API class InsightsConfigServiceClient.

InsightsConfigService client wrapper, for convenient use.

Inheritance

object > InsightsConfigServiceClient

Namespace

Google.Cloud.DeveloperConnect.V1

Assembly

Google.Cloud.DeveloperConnect.V1.dll

Remarks

Creates and manages InsightsConfigs.

The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. A user can create an InsightsConfig, list previously-requested InsightsConfigs or get InsightsConfigs by their ID to determine the status of the InsightsConfig.

Properties

CreateInsightsConfigOperationsClient

public virtual OperationsClient CreateInsightsConfigOperationsClient { get; }

The long-running operations client for CreateInsightsConfig.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default InsightsConfigService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default InsightsConfigService scopes are:

DeleteInsightsConfigOperationsClient

public virtual OperationsClient DeleteInsightsConfigOperationsClient { get; }

The long-running operations client for DeleteInsightsConfig.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual InsightsConfigService.InsightsConfigServiceClient GrpcClient { get; }

The underlying gRPC InsightsConfigService client

Property Value
Type Description
InsightsConfigServiceInsightsConfigServiceClient

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

UpdateInsightsConfigOperationsClient

public virtual OperationsClient UpdateInsightsConfigOperationsClient { get; }

The long-running operations client for UpdateInsightsConfig.

Property Value
Type Description
OperationsClient

Methods

Create()

public static InsightsConfigServiceClient Create()

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

Returns
Type Description
InsightsConfigServiceClient

The created InsightsConfigServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskInsightsConfigServiceClient

The task representing the created InsightsConfigServiceClient.

CreateInsightsConfig(LocationName, InsightsConfig, string, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> CreateInsightsConfig(LocationName parent, InsightsConfig insightsConfig, string insightsConfigId, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInsightsConfigOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = insightsConfigServiceClient.CreateInsightsConfig(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceCreateInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfig(CreateInsightsConfigRequest, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> CreateInsightsConfig(CreateInsightsConfigRequest request, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
request CreateInsightsConfigRequest

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
OperationInsightsConfigOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
CreateInsightsConfigRequest request = new CreateInsightsConfigRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InsightsConfigId = "",
    InsightsConfig = new InsightsConfig(),
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = insightsConfigServiceClient.CreateInsightsConfig(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceCreateInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfig(string, InsightsConfig, string, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> CreateInsightsConfig(string parent, InsightsConfig insightsConfig, string insightsConfigId, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInsightsConfigOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = insightsConfigServiceClient.CreateInsightsConfig(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceCreateInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(LocationName, InsightsConfig, string, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(LocationName parent, InsightsConfig insightsConfig, string insightsConfigId, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(LocationName, InsightsConfig, string, CancellationToken)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(LocationName parent, InsightsConfig insightsConfig, string insightsConfigId, CancellationToken cancellationToken)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(CreateInsightsConfigRequest, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(CreateInsightsConfigRequest request, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
request CreateInsightsConfigRequest

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
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CreateInsightsConfigRequest request = new CreateInsightsConfigRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InsightsConfigId = "",
    InsightsConfig = new InsightsConfig(),
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(CreateInsightsConfigRequest, CancellationToken)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(CreateInsightsConfigRequest request, CancellationToken cancellationToken)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
request CreateInsightsConfigRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CreateInsightsConfigRequest request = new CreateInsightsConfigRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InsightsConfigId = "",
    InsightsConfig = new InsightsConfig(),
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(string, InsightsConfig, string, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(string parent, InsightsConfig insightsConfig, string insightsConfigId, CallSettings callSettings = null)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

CreateInsightsConfigAsync(string, InsightsConfig, string, CancellationToken)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> CreateInsightsConfigAsync(string parent, InsightsConfig insightsConfig, string insightsConfigId, CancellationToken cancellationToken)

Creates a new InsightsConfig in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

insightsConfig InsightsConfig

Required. The resource being created.

insightsConfigId string

Required. ID of the requesting InsightsConfig.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
InsightsConfig insightsConfig = new InsightsConfig();
string insightsConfigId = "";
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.CreateInsightsConfigAsync(parent, insightsConfig, insightsConfigId);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceCreateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfig(DeleteInsightsConfigRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteInsightsConfig(DeleteInsightsConfigRequest request, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
request DeleteInsightsConfigRequest

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
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
DeleteInsightsConfigRequest request = new DeleteInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
    RequestId = "",
    ValidateOnly = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = insightsConfigServiceClient.DeleteInsightsConfig(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceDeleteInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfig(InsightsConfigName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteInsightsConfig(InsightsConfigName name, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Value for parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = insightsConfigServiceClient.DeleteInsightsConfig(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceDeleteInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfig(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteInsightsConfig(string name, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
name string

Required. Value for parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = insightsConfigServiceClient.DeleteInsightsConfig(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceDeleteInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(DeleteInsightsConfigRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(DeleteInsightsConfigRequest request, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
request DeleteInsightsConfigRequest

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
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteInsightsConfigRequest request = new DeleteInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
    RequestId = "",
    ValidateOnly = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(DeleteInsightsConfigRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(DeleteInsightsConfigRequest request, CancellationToken cancellationToken)

Delete a single Insight.

Parameters
Name Description
request DeleteInsightsConfigRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteInsightsConfigRequest request = new DeleteInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
    RequestId = "",
    ValidateOnly = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(InsightsConfigName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(InsightsConfigName name, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Value for parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(InsightsConfigName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(InsightsConfigName name, CancellationToken cancellationToken)

Delete a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Value for parent.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(string name, CallSettings callSettings = null)

Delete a single Insight.

Parameters
Name Description
name string

Required. Value for parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInsightsConfigAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInsightsConfigAsync(string name, CancellationToken cancellationToken)

Delete a single Insight.

Parameters
Name Description
name string

Required. Value for parent.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await insightsConfigServiceClient.DeleteInsightsConfigAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceDeleteInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetInsightsConfig(GetInsightsConfigRequest, CallSettings)

public virtual InsightsConfig GetInsightsConfig(GetInsightsConfigRequest request, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
request GetInsightsConfigRequest

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
InsightsConfig

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
GetInsightsConfigRequest request = new GetInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
};
// Make the request
InsightsConfig response = insightsConfigServiceClient.GetInsightsConfig(request);

GetInsightsConfig(InsightsConfigName, CallSettings)

public virtual InsightsConfig GetInsightsConfig(InsightsConfigName name, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InsightsConfig

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
InsightsConfig response = insightsConfigServiceClient.GetInsightsConfig(name);

GetInsightsConfig(string, CallSettings)

public virtual InsightsConfig GetInsightsConfig(string name, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InsightsConfig

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
InsightsConfig response = insightsConfigServiceClient.GetInsightsConfig(name);

GetInsightsConfigAsync(GetInsightsConfigRequest, CallSettings)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(GetInsightsConfigRequest request, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
request GetInsightsConfigRequest

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
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetInsightsConfigRequest request = new GetInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
};
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(request);

GetInsightsConfigAsync(GetInsightsConfigRequest, CancellationToken)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(GetInsightsConfigRequest request, CancellationToken cancellationToken)

Gets details of a single Insight.

Parameters
Name Description
request GetInsightsConfigRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetInsightsConfigRequest request = new GetInsightsConfigRequest
{
    InsightsConfigName = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]"),
};
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(request);

GetInsightsConfigAsync(InsightsConfigName, CallSettings)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(InsightsConfigName name, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(name);

GetInsightsConfigAsync(InsightsConfigName, CancellationToken)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(InsightsConfigName name, CancellationToken cancellationToken)

Gets details of a single Insight.

Parameters
Name Description
name InsightsConfigName

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
InsightsConfigName name = InsightsConfigName.FromProjectLocationInsightsConfig("[PROJECT]", "[LOCATION]", "[INSIGHTS_CONFIG]");
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(name);

GetInsightsConfigAsync(string, CallSettings)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(string name, CallSettings callSettings = null)

Gets details of a single Insight.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(name);

GetInsightsConfigAsync(string, CancellationToken)

public virtual Task<InsightsConfig> GetInsightsConfigAsync(string name, CancellationToken cancellationToken)

Gets details of a single Insight.

Parameters
Name Description
name string

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInsightsConfig

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/insightsConfigs/[INSIGHTS_CONFIG]";
// Make the request
InsightsConfig response = await insightsConfigServiceClient.GetInsightsConfigAsync(name);

ListInsightsConfigs(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigs(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListInsightsConfigsRequest.

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
PagedEnumerableListInsightsConfigsResponseInsightsConfig

A pageable sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigs(parent);

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

ListInsightsConfigs(ListInsightsConfigsRequest, CallSettings)

public virtual PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigs(ListInsightsConfigsRequest request, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
request ListInsightsConfigsRequest

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
PagedEnumerableListInsightsConfigsResponseInsightsConfig

A pageable sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
ListInsightsConfigsRequest request = new ListInsightsConfigsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigs(request);

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

ListInsightsConfigs(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListInsightsConfigsRequest.

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
PagedEnumerableListInsightsConfigsResponseInsightsConfig

A pageable sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigs(parent);

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

ListInsightsConfigsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListInsightsConfigsRequest.

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
PagedAsyncEnumerableListInsightsConfigsResponseInsightsConfig

A pageable asynchronous sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigsAsync(parent);

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

ListInsightsConfigsAsync(ListInsightsConfigsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigsAsync(ListInsightsConfigsRequest request, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
request ListInsightsConfigsRequest

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
PagedAsyncEnumerableListInsightsConfigsResponseInsightsConfig

A pageable asynchronous sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ListInsightsConfigsRequest request = new ListInsightsConfigsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigsAsync(request);

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

ListInsightsConfigsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> ListInsightsConfigsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists InsightsConfigs in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListInsightsConfigsRequest.

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
PagedAsyncEnumerableListInsightsConfigsResponseInsightsConfig

A pageable asynchronous sequence of InsightsConfig resources.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListInsightsConfigsResponse, InsightsConfig> response = insightsConfigServiceClient.ListInsightsConfigsAsync(parent);

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

PollOnceCreateInsightsConfig(string, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> PollOnceCreateInsightsConfig(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateInsightsConfig .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInsightsConfigOperationMetadata

The result of polling the operation.

PollOnceCreateInsightsConfigAsync(string, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> PollOnceCreateInsightsConfigAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateInsightsConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteInsightsConfig(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteInsightsConfig(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteInsightsConfig .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteInsightsConfigAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteInsightsConfigAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteInsightsConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateInsightsConfig(string, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> PollOnceUpdateInsightsConfig(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateInsightsConfig .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInsightsConfigOperationMetadata

The result of polling the operation.

PollOnceUpdateInsightsConfigAsync(string, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> PollOnceUpdateInsightsConfigAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateInsightsConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A task representing the result of polling the operation.

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.

UpdateInsightsConfig(UpdateInsightsConfigRequest, CallSettings)

public virtual Operation<InsightsConfig, OperationMetadata> UpdateInsightsConfig(UpdateInsightsConfigRequest request, CallSettings callSettings = null)

Updates the parameters of a single InsightsConfig.

Parameters
Name Description
request UpdateInsightsConfigRequest

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
OperationInsightsConfigOperationMetadata

The RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = InsightsConfigServiceClient.Create();
// Initialize request argument(s)
UpdateInsightsConfigRequest request = new UpdateInsightsConfigRequest
{
    InsightsConfig = new InsightsConfig(),
    RequestId = "",
    AllowMissing = false,
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = insightsConfigServiceClient.UpdateInsightsConfig(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = insightsConfigServiceClient.PollOnceUpdateInsightsConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

UpdateInsightsConfigAsync(UpdateInsightsConfigRequest, CallSettings)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> UpdateInsightsConfigAsync(UpdateInsightsConfigRequest request, CallSettings callSettings = null)

Updates the parameters of a single InsightsConfig.

Parameters
Name Description
request UpdateInsightsConfigRequest

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
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateInsightsConfigRequest request = new UpdateInsightsConfigRequest
{
    InsightsConfig = new InsightsConfig(),
    RequestId = "",
    AllowMissing = false,
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.UpdateInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceUpdateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}

UpdateInsightsConfigAsync(UpdateInsightsConfigRequest, CancellationToken)

public virtual Task<Operation<InsightsConfig, OperationMetadata>> UpdateInsightsConfigAsync(UpdateInsightsConfigRequest request, CancellationToken cancellationToken)

Updates the parameters of a single InsightsConfig.

Parameters
Name Description
request UpdateInsightsConfigRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInsightsConfigOperationMetadata

A Task containing the RPC response.

Example
// Create client
InsightsConfigServiceClient insightsConfigServiceClient = await InsightsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateInsightsConfigRequest request = new UpdateInsightsConfigRequest
{
    InsightsConfig = new InsightsConfig(),
    RequestId = "",
    AllowMissing = false,
    ValidateOnly = false,
};
// Make the request
Operation<InsightsConfig, OperationMetadata> response = await insightsConfigServiceClient.UpdateInsightsConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<InsightsConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
InsightsConfig result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<InsightsConfig, OperationMetadata> retrievedResponse = await insightsConfigServiceClient.PollOnceUpdateInsightsConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    InsightsConfig retrievedResult = retrievedResponse.Result;
}