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

public class AppTopology.AppTopologyClient : ClientBase<AppTopology.AppTopologyClient>

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

Client for AppTopology

Inheritance

object > ClientBase > ClientBaseAppTopologyAppTopologyClient > AppTopology.AppTopologyClient

Namespace

Google.Cloud.AppTopology.V1

Assembly

Google.Cloud.AppTopology.V1.dll

Constructors

AppTopologyClient()

protected AppTopologyClient()

Protected parameterless constructor to allow creation of test doubles.

AppTopologyClient(CallInvoker)

public AppTopologyClient(CallInvoker callInvoker)

Creates a new client for AppTopology that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AppTopologyClient(ChannelBase)

public AppTopologyClient(ChannelBase channel)

Creates a new client for AppTopology

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AppTopologyClient(ClientBaseConfiguration)

protected AppTopologyClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest, CallOptions)

public virtual GenerateDiscoveredResourcesTopologyResponse GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
GenerateDiscoveredResourcesTopologyResponse

The response received from the server.

GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateDiscoveredResourcesTopologyResponse GenerateDiscoveredResourcesTopology(GenerateDiscoveredResourcesTopologyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
GenerateDiscoveredResourcesTopologyResponse

The response received from the server.

GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallGenerateDiscoveredResourcesTopologyResponse

The call object.

GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateDiscoveredResourcesTopologyResponse> GenerateDiscoveredResourcesTopologyAsync(GenerateDiscoveredResourcesTopologyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallGenerateDiscoveredResourcesTopologyResponse

The call object.

GetDomain(GetDomainRequest, CallOptions)

public virtual Domain GetDomain(GetDomainRequest request, CallOptions options)

Retrieves the specified topology domain.

Parameters
Name Description
request GetDomainRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Domain

The response received from the server.

GetDomain(GetDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual Domain GetDomain(GetDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified topology domain.

Parameters
Name Description
request GetDomainRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Domain

The response received from the server.

GetDomainAsync(GetDomainRequest, CallOptions)

public virtual AsyncUnaryCall<Domain> GetDomainAsync(GetDomainRequest request, CallOptions options)

Retrieves the specified topology domain.

Parameters
Name Description
request GetDomainRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallDomain

The call object.

GetDomainAsync(GetDomainRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Domain> GetDomainAsync(GetDomainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified topology domain.

Parameters
Name Description
request GetDomainRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallDomain

The call object.

GetSchema(GetSchemaRequest, CallOptions)

public virtual Schema GetSchema(GetSchemaRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Schema

The response received from the server.

GetSchema(GetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema GetSchema(GetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Schema

The response received from the server.

GetSchemaAsync(GetSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> GetSchemaAsync(GetSchemaRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSchema

The call object.

GetSchemaAsync(GetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> GetSchemaAsync(GetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSchema

The call object.

ListDomains(ListDomainsRequest, CallOptions)

public virtual ListDomainsResponse ListDomains(ListDomainsRequest request, CallOptions options)

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

Parameters
Name Description
request ListDomainsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListDomainsResponse

The response received from the server.

ListDomains(ListDomainsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDomainsResponse ListDomains(ListDomainsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListDomainsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListDomainsResponse

The response received from the server.

ListDomainsAsync(ListDomainsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDomainsResponse> ListDomainsAsync(ListDomainsRequest request, CallOptions options)

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

Parameters
Name Description
request ListDomainsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListDomainsResponse

The call object.

ListDomainsAsync(ListDomainsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDomainsResponse> ListDomainsAsync(ListDomainsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListDomainsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListDomainsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override AppTopology.AppTopologyClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AppTopologyAppTopologyClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AppTopology.V1.AppTopology.AppTopologyClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)