Dataform V1 API - Class Google::Cloud::Dataform::V1::QueryFolderContentsRequest (v0.4.0)

Reference documentation and code samples for the Dataform V1 API class Google::Cloud::Dataform::V1::QueryFolderContentsRequest.

QueryFolderContents request message.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

    • filter="display_name="MyFolder""

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

    • filter="display_name="MyFolder""
Returns
  • (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

    • filter="display_name="MyFolder""

#folder

def folder() -> ::String
Returns
  • (::String) — Required. Name of the folder whose contents to list. Format: projects//locations//folders/*

#folder=

def folder=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the folder whose contents to list. Format: projects//locations//folders/*
Returns
  • (::String) — Required. Name of the folder whose contents to list. Format: projects//locations//folders/*

#order_by

def order_by() -> ::String
Returns
  • (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"
Returns
  • (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Returns
  • (::Integer) — Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

Returns
  • (::String) — Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.