App Topology V1 API - Class Google::Cloud::AppTopology::V1::ExploreSchemaRequest (v0.2.0)

Reference documentation and code samples for the App Topology V1 API class Google::Cloud::AppTopology::V1::ExploreSchemaRequest.

Request for ExploreSchema.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#depth

def depth() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.

#depth=

def depth=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.
Returns
  • (::Integer) — Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
Returns
  • (::String) — Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) —

    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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) —

    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.
Returns
  • (::Integer) —

    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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#start_labels

def start_labels() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#start_labels=

def start_labels=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.