App Topology v1 API - Class AppTopologyClient (1.0.0-beta01)

public abstract class AppTopologyClient

Reference documentation and code samples for the App Topology v1 API class AppTopologyClient.

AppTopology client wrapper, for convenient use.

Inheritance

object > AppTopologyClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

AppTopologyClientImpl

Namespace

Google.Cloud.AppTopology.V1

Assembly

Google.Cloud.AppTopology.V1.dll

Remarks

Service describing handlers for resources

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AppTopology scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default AppTopology scopes are:

• https://www.googleapis.com/auth/apptopology.read-only
• https://www.googleapis.com/auth/apptopology.read-write
• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual AppTopology.AppTopologyClient GrpcClient { get; }

The underlying gRPC AppTopology client

Property Value
Type	Description
AppTopologyAppTopologyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static AppTopologyClient Create()

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

Returns
Type	Description
AppTopologyClient	The created AppTopologyClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
TaskAppTopologyClient	The task representing the created AppTopologyClient.

GenerateDiscoveredResourcesTopology(DiscoveredResourcesTopologyName, IEnumerable<DomainName>, CallSettings)

public virtual GenerateDiscoveredResourcesTopologyResponse GenerateDiscoveredResourcesTopology(DiscoveredResourcesTopologyName name, IEnumerable<DomainName> topologyDomains, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	DiscoveredResourcesTopologyName Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerableDomainName Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GenerateDiscoveredResourcesTopologyResponse	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
DiscoveredResourcesTopologyName name = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<DomainName> topologyDomains = new DomainName[]
{
    DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = appTopologyClient.GenerateDiscoveredResourcesTopology(name, topologyDomains);

GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest, CallSettings)

public virtual GenerateDiscoveredResourcesTopologyResponse GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest request, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

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

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
GenerateDiscoveredResourcesTopologyRequest request = new GenerateDiscoveredResourcesTopologyRequest
{
    DiscoveredResourcesTopologyName = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TopologyDomainsAsDomainNames =
    {
        DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
    },
    Filter = new GraphPattern(),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = appTopologyClient.GenerateDiscoveredResourcesTopology(request);

GenerateDiscoveredResourcesTopology(string, IEnumerable<string>, CallSettings)

public virtual GenerateDiscoveredResourcesTopologyResponse GenerateDiscoveredResourcesTopology(string name, IEnumerable<string> topologyDomains, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	string Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerablestring Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GenerateDiscoveredResourcesTopologyResponse	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/discoveredResourcesTopology";
IEnumerable<string> topologyDomains = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]",
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = appTopologyClient.GenerateDiscoveredResourcesTopology(name, topologyDomains);

GenerateDiscoveredResourcesTopologyAsync(DiscoveredResourcesTopologyName, IEnumerable<DomainName>, CallSettings)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(DiscoveredResourcesTopologyName name, IEnumerable<DomainName> topologyDomains, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	DiscoveredResourcesTopologyName Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerableDomainName Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskGenerateDiscoveredResourcesTopologyResponse	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
DiscoveredResourcesTopologyName name = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<DomainName> topologyDomains = new DomainName[]
{
    DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(name, topologyDomains);

GenerateDiscoveredResourcesTopologyAsync(DiscoveredResourcesTopologyName, IEnumerable<DomainName>, CancellationToken)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(DiscoveredResourcesTopologyName name, IEnumerable<DomainName> topologyDomains, CancellationToken cancellationToken)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	DiscoveredResourcesTopologyName Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerableDomainName Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskGenerateDiscoveredResourcesTopologyResponse	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
DiscoveredResourcesTopologyName name = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<DomainName> topologyDomains = new DomainName[]
{
    DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(name, topologyDomains);

GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest, CallSettings)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest request, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

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

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GenerateDiscoveredResourcesTopologyRequest request = new GenerateDiscoveredResourcesTopologyRequest
{
    DiscoveredResourcesTopologyName = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TopologyDomainsAsDomainNames =
    {
        DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
    },
    Filter = new GraphPattern(),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(request);

GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest, CancellationToken)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest request, CancellationToken cancellationToken)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

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

Returns
Type	Description
TaskGenerateDiscoveredResourcesTopologyResponse	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GenerateDiscoveredResourcesTopologyRequest request = new GenerateDiscoveredResourcesTopologyRequest
{
    DiscoveredResourcesTopologyName = DiscoveredResourcesTopologyName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TopologyDomainsAsDomainNames =
    {
        DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
    },
    Filter = new GraphPattern(),
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(request);

GenerateDiscoveredResourcesTopologyAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(string name, IEnumerable<string> topologyDomains, CallSettings callSettings = null)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	string Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerablestring Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskGenerateDiscoveredResourcesTopologyResponse	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/discoveredResourcesTopology";
IEnumerable<string> topologyDomains = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]",
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(name, topologyDomains);

GenerateDiscoveredResourcesTopologyAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(string name, IEnumerable<string> topologyDomains, CancellationToken cancellationToken)

Generate the topology for all resources in the given project. If the project represents an app boundary, the topology is generated for all resources in the boundary.

Parameters
Name	Description
name	string Required. The project to query discoverable resources on. Expected format: projects/{project}/locations/{location}/discoveredResourcesTopology. Only global location is supported.
topologyDomains	IEnumerablestring Required. The full resource name of the domain of the app topology. Format: projects/{project}/locations/{location}/domains/{domain} Caller must have apptopology.domains.get permission on each of the domains.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskGenerateDiscoveredResourcesTopologyResponse	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/discoveredResourcesTopology";
IEnumerable<string> topologyDomains = new string[]
{
    "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]",
};
// Make the request
GenerateDiscoveredResourcesTopologyResponse response = await appTopologyClient.GenerateDiscoveredResourcesTopologyAsync(name, topologyDomains);

GetDomain(DomainName, CallSettings)

public virtual Domain GetDomain(DomainName name, CallSettings callSettings = null)

Retrieves the specified topology domain.

Parameters
Name	Description
name	DomainName Required. The name of the domain to retrieve. Format: projects/{project}/locations/{location}/domains/{domain}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Domain	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
DomainName name = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Domain response = appTopologyClient.GetDomain(name);

GetDomain(GetDomainRequest, CallSettings)

public virtual Domain GetDomain(GetDomainRequest request, CallSettings callSettings = null)

Retrieves the specified topology domain.

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

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
GetDomainRequest request = new GetDomainRequest
{
    DomainName = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Domain response = appTopologyClient.GetDomain(request);

GetDomain(string, CallSettings)

public virtual Domain GetDomain(string name, CallSettings callSettings = null)

Retrieves the specified topology domain.

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

Returns
Type	Description
Domain	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]";
// Make the request
Domain response = appTopologyClient.GetDomain(name);

GetDomainAsync(DomainName, CallSettings)

public virtual Task<Domain> GetDomainAsync(DomainName name, CallSettings callSettings = null)

Retrieves the specified topology domain.

Parameters
Name	Description
name	DomainName Required. The name of the domain to retrieve. Format: projects/{project}/locations/{location}/domains/{domain}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskDomain	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
DomainName name = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(name);

GetDomainAsync(DomainName, CancellationToken)

public virtual Task<Domain> GetDomainAsync(DomainName name, CancellationToken cancellationToken)

Retrieves the specified topology domain.

Parameters
Name	Description
name	DomainName Required. The name of the domain to retrieve. Format: projects/{project}/locations/{location}/domains/{domain}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskDomain	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
DomainName name = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(name);

GetDomainAsync(GetDomainRequest, CallSettings)

public virtual Task<Domain> GetDomainAsync(GetDomainRequest request, CallSettings callSettings = null)

Retrieves the specified topology domain.

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

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GetDomainRequest request = new GetDomainRequest
{
    DomainName = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(request);

GetDomainAsync(GetDomainRequest, CancellationToken)

public virtual Task<Domain> GetDomainAsync(GetDomainRequest request, CancellationToken cancellationToken)

Retrieves the specified topology domain.

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

Returns
Type	Description
TaskDomain	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GetDomainRequest request = new GetDomainRequest
{
    DomainName = DomainName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(request);

GetDomainAsync(string, CallSettings)

public virtual Task<Domain> GetDomainAsync(string name, CallSettings callSettings = null)

Retrieves the specified topology domain.

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

Returns
Type	Description
TaskDomain	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]";
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(name);

GetDomainAsync(string, CancellationToken)

public virtual Task<Domain> GetDomainAsync(string name, CancellationToken cancellationToken)

Retrieves the specified topology domain.

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

Returns
Type	Description
TaskDomain	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]";
// Make the request
Domain response = await appTopologyClient.GetDomainAsync(name);

GetSchema(GetSchemaRequest, CallSettings)

public virtual Schema GetSchema(GetSchemaRequest request, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

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

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
GetSchemaRequest request = new GetSchemaRequest
{
    SchemaName = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Schema response = appTopologyClient.GetSchema(request);

GetSchema(SchemaName, CallSettings)

public virtual Schema GetSchema(SchemaName name, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	SchemaName Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
SchemaName name = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Schema response = appTopologyClient.GetSchema(name);

GetSchema(string, CallSettings)

public virtual Schema GetSchema(string name, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	string Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]/schema";
// Make the request
Schema response = appTopologyClient.GetSchema(name);

GetSchemaAsync(GetSchemaRequest, CallSettings)

public virtual Task<Schema> GetSchemaAsync(GetSchemaRequest request, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

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

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GetSchemaRequest request = new GetSchemaRequest
{
    SchemaName = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(request);

GetSchemaAsync(GetSchemaRequest, CancellationToken)

public virtual Task<Schema> GetSchemaAsync(GetSchemaRequest request, CancellationToken cancellationToken)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

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

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
GetSchemaRequest request = new GetSchemaRequest
{
    SchemaName = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]"),
};
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(request);

GetSchemaAsync(SchemaName, CallSettings)

public virtual Task<Schema> GetSchemaAsync(SchemaName name, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	SchemaName Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
SchemaName name = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(name);

GetSchemaAsync(SchemaName, CancellationToken)

public virtual Task<Schema> GetSchemaAsync(SchemaName name, CancellationToken cancellationToken)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	SchemaName Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
SchemaName name = SchemaName.FromProjectLocationDomain("[PROJECT]", "[LOCATION]", "[DOMAIN]");
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(name);

GetSchemaAsync(string, CallSettings)

public virtual Task<Schema> GetSchemaAsync(string name, CallSettings callSettings = null)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	string Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]/schema";
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(name);

GetSchemaAsync(string, CancellationToken)

public virtual Task<Schema> GetSchemaAsync(string name, CancellationToken cancellationToken)

Retrieves the schema for the specified topology domain. The schema defines the NodeTypes and EdgeTypes that are supported in GenerateDiscoveredResourcesTopology requests and responses for a given domain.

Parameters
Name	Description
name	string Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/domains/[DOMAIN]/schema";
// Make the request
Schema response = await appTopologyClient.GetSchemaAsync(name);

ListDomains(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDomainsResponse, Domain> ListDomains(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
parent	LocationName Required. The parent location to list domains for. Format: projects/{project}/locations/{location} Only global location is supported.
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
PagedEnumerableListDomainsResponseDomain	A pageable sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomains(parent);

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

ListDomains(ListDomainsRequest, CallSettings)

public virtual PagedEnumerable<ListDomainsResponse, Domain> ListDomains(ListDomainsRequest request, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
request	ListDomainsRequest 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
PagedEnumerableListDomainsResponseDomain	A pageable sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
ListDomainsRequest request = new ListDomainsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomains(request);

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

ListDomains(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDomainsResponse, Domain> ListDomains(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
parent	string Required. The parent location to list domains for. Format: projects/{project}/locations/{location} Only global location is supported.
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
PagedEnumerableListDomainsResponseDomain	A pageable sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = AppTopologyClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomains(parent);

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

ListDomainsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDomainsResponse, Domain> ListDomainsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
parent	LocationName Required. The parent location to list domains for. Format: projects/{project}/locations/{location} Only global location is supported.
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
PagedAsyncEnumerableListDomainsResponseDomain	A pageable asynchronous sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomainsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Domain item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListDomainsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Domain 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<Domain> 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 (Domain 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;

ListDomainsAsync(ListDomainsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDomainsResponse, Domain> ListDomainsAsync(ListDomainsRequest request, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
request	ListDomainsRequest 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
PagedAsyncEnumerableListDomainsResponseDomain	A pageable asynchronous sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
ListDomainsRequest request = new ListDomainsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomainsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Domain item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListDomainsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Domain 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<Domain> 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 (Domain 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;

ListDomainsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDomainsResponse, Domain> ListDomainsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topology domains available in a specific location. Only global location is supported.

Parameters
Name	Description
parent	string Required. The parent location to list domains for. Format: projects/{project}/locations/{location} Only global location is supported.
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
PagedAsyncEnumerableListDomainsResponseDomain	A pageable asynchronous sequence of Domain resources.

Example

// Create client
AppTopologyClient appTopologyClient = await AppTopologyClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListDomainsResponse, Domain> response = appTopologyClient.ListDomainsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Domain item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListDomainsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Domain 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<Domain> 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 (Domain item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.