Data Lineage v1 API - Class ConfigManagementServiceClient (1.0.0-beta01)

public abstract class ConfigManagementServiceClient

Reference documentation and code samples for the Data Lineage v1 API class ConfigManagementServiceClient.

ConfigManagementService client wrapper, for convenient use.

Inheritance

object > ConfigManagementServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ConfigManagementServiceClientImpl

Namespace

Google.Cloud.DataCatalog.Lineage.ConfigManagement.V1

Assembly

Google.Cloud.DataCatalog.Lineage.ConfigManagement.V1.dll

Remarks

Lineage Config Management service. Config Management service is used to manage the configuration for Data Lineage. These Configs define different configuration options for Lineage customers to control behaviour of lineage systems.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ConfigManagementService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default ConfigManagementService scopes are:

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

GrpcClient

public virtual ConfigManagementService.ConfigManagementServiceClient GrpcClient { get; }

The underlying gRPC ConfigManagementService client

Property Value
Type	Description
ConfigManagementServiceConfigManagementServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static ConfigManagementServiceClient Create()

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

Returns
Type	Description
ConfigManagementServiceClient	The created ConfigManagementServiceClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
TaskConfigManagementServiceClient	The task representing the created ConfigManagementServiceClient.

GetConfig(ConfigName, CallSettings)

public virtual Config GetConfig(ConfigName name, CallSettings callSettings = null)

Get the Config for a given resource.

Parameters
Name	Description
name	ConfigName Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Config	The RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = ConfigManagementServiceClient.Create();
// Initialize request argument(s)
ConfigName name = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
Config response = configManagementServiceClient.GetConfig(name);

GetConfig(GetConfigRequest, CallSettings)

public virtual Config GetConfig(GetConfigRequest request, CallSettings callSettings = null)

Get the Config for a given resource.

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

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = ConfigManagementServiceClient.Create();
// Initialize request argument(s)
GetConfigRequest request = new GetConfigRequest
{
    ConfigName = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
Config response = configManagementServiceClient.GetConfig(request);

GetConfig(string, CallSettings)

public virtual Config GetConfig(string name, CallSettings callSettings = null)

Get the Config for a given resource.

Parameters
Name	Description
name	string Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Config	The RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = ConfigManagementServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/config";
// Make the request
Config response = configManagementServiceClient.GetConfig(name);

GetConfigAsync(ConfigName, CallSettings)

public virtual Task<Config> GetConfigAsync(ConfigName name, CallSettings callSettings = null)

Get the Config for a given resource.

Parameters
Name	Description
name	ConfigName Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
ConfigName name = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(name);

GetConfigAsync(ConfigName, CancellationToken)

public virtual Task<Config> GetConfigAsync(ConfigName name, CancellationToken cancellationToken)

Get the Config for a given resource.

Parameters
Name	Description
name	ConfigName Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
ConfigName name = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(name);

GetConfigAsync(GetConfigRequest, CallSettings)

public virtual Task<Config> GetConfigAsync(GetConfigRequest request, CallSettings callSettings = null)

Get the Config for a given resource.

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

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
GetConfigRequest request = new GetConfigRequest
{
    ConfigName = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(request);

GetConfigAsync(GetConfigRequest, CancellationToken)

public virtual Task<Config> GetConfigAsync(GetConfigRequest request, CancellationToken cancellationToken)

Get the Config for a given resource.

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

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
GetConfigRequest request = new GetConfigRequest
{
    ConfigName = ConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(request);

GetConfigAsync(string, CallSettings)

public virtual Task<Config> GetConfigAsync(string name, CallSettings callSettings = null)

Get the Config for a given resource.

Parameters
Name	Description
name	string Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/config";
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(name);

GetConfigAsync(string, CancellationToken)

public virtual Task<Config> GetConfigAsync(string name, CancellationToken cancellationToken)

Get the Config for a given resource.

Parameters
Name	Description
name	string Required. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/config";
// Make the request
Config response = await configManagementServiceClient.GetConfigAsync(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.

UpdateConfig(Config, CallSettings)

public virtual Config UpdateConfig(Config config, CallSettings callSettings = null)

Update the Config for a given resource.

Parameters
Name	Description
config	Config Required. REQUIRED: The config to be applied to the resource and all its descendants.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Config	The RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = ConfigManagementServiceClient.Create();
// Initialize request argument(s)
Config config = new Config();
// Make the request
Config response = configManagementServiceClient.UpdateConfig(config);

UpdateConfig(UpdateConfigRequest, CallSettings)

public virtual Config UpdateConfig(UpdateConfigRequest request, CallSettings callSettings = null)

Update the Config for a given resource.

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

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = ConfigManagementServiceClient.Create();
// Initialize request argument(s)
UpdateConfigRequest request = new UpdateConfigRequest
{
    Config = new Config(),
};
// Make the request
Config response = configManagementServiceClient.UpdateConfig(request);

UpdateConfigAsync(Config, CallSettings)

public virtual Task<Config> UpdateConfigAsync(Config config, CallSettings callSettings = null)

Update the Config for a given resource.

Parameters
Name	Description
config	Config Required. REQUIRED: The config to be applied to the resource and all its descendants.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
Config config = new Config();
// Make the request
Config response = await configManagementServiceClient.UpdateConfigAsync(config);

UpdateConfigAsync(Config, CancellationToken)

public virtual Task<Config> UpdateConfigAsync(Config config, CancellationToken cancellationToken)

Update the Config for a given resource.

Parameters
Name	Description
config	Config Required. REQUIRED: The config to be applied to the resource and all its descendants.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
Config config = new Config();
// Make the request
Config response = await configManagementServiceClient.UpdateConfigAsync(config);

UpdateConfigAsync(UpdateConfigRequest, CallSettings)

public virtual Task<Config> UpdateConfigAsync(UpdateConfigRequest request, CallSettings callSettings = null)

Update the Config for a given resource.

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

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateConfigRequest request = new UpdateConfigRequest
{
    Config = new Config(),
};
// Make the request
Config response = await configManagementServiceClient.UpdateConfigAsync(request);

UpdateConfigAsync(UpdateConfigRequest, CancellationToken)

public virtual Task<Config> UpdateConfigAsync(UpdateConfigRequest request, CancellationToken cancellationToken)

Update the Config for a given resource.

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

Returns
Type	Description
TaskConfig	A Task containing the RPC response.

Example

// Create client
ConfigManagementServiceClient configManagementServiceClient = await ConfigManagementServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateConfigRequest request = new UpdateConfigRequest
{
    Config = new Config(),
};
// Make the request
Config response = await configManagementServiceClient.UpdateConfigAsync(request);