App Topology v1 API - Class ExploreSchemaRequest (1.0.0-beta02) 

public sealed class ExploreSchemaRequest : IPageRequest, IMessage<ExploreSchemaRequest>, IEquatable<ExploreSchemaRequest>, IDeepCloneable<ExploreSchemaRequest>, IBufferMessage, IMessage

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

Request for ExploreSchema.

Inheritance

object > ExploreSchemaRequest

Namespace

Google.Cloud.AppTopology.V1

Assembly

Google.Cloud.AppTopology.V1.dll

Constructors

ExploreSchemaRequest()

public ExploreSchemaRequest()

ExploreSchemaRequest(ExploreSchemaRequest)

public ExploreSchemaRequest(ExploreSchemaRequest other)
Parameter
Name Description
other ExploreSchemaRequest

Properties

Depth

public int Depth { get; set; }

Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.

Property Value
Type Description
int

Name

public string Name { get; set; }

Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of schema elements to return in a single page.

  • The service might return fewer elements than this value if adding another edge and its required endpoint nodes exceeds page_size.
  • If omitted or set to 0, default (100) will be used.
  • Minimum page_size is 3 to ensure at least one edge and its endpoint nodes fit on a page; values below 3 (e.g. 1 or 2) are changed to 3.
  • Maximum value is 500.
Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. A page token received from a previous ExploreSchema call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ExploreSchema must match the call that provided the page token.

Property Value
Type Description
string

SchemaName

public SchemaName SchemaName { get; set; }

SchemaName-typed view over the Name resource name property.

Property Value
Type Description
SchemaName

StartLabels

public RepeatedField<string> StartLabels { get; }

Optional. Starting label names to begin traversal. Substring, case-insensitive matches are performed against allowed label names in the schema. A maximum of 10 start_labels can be specified; providing more will result in an INVALID_ARGUMENT error. If start_labels is unset or empty, all authorized node types will be used as the starting set.

Property Value
Type Description
RepeatedFieldstring