Resource Manager V3 API - Class Google::Cloud::ResourceManager::V3::SearchOrganizationsRequest (v0.7.0)

Reference documentation and code samples for the Resource Manager V3 API class Google::Cloud::ResourceManager::V3::SearchOrganizationsRequest.

The request sent to the SearchOrganizations method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.
Returns
  • (::Integer) — Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.
Returns
  • (::String) — Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.

#query

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

    Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.

    | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. |

    Organizations may be queried by directoryCustomerId or by domain, where the domain is a G Suite domain, for example:

    • Query directorycustomerid:123456789 returns Organization resources with owner.directory_customer_id equal to 123456789.
    • Query domain:google.com returns Organization resources corresponding to the domain google.com.

#query=

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

    Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.

    | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. |

    Organizations may be queried by directoryCustomerId or by domain, where the domain is a G Suite domain, for example:

    • Query directorycustomerid:123456789 returns Organization resources with owner.directory_customer_id equal to 123456789.
    • Query domain:google.com returns Organization resources corresponding to the domain google.com.
Returns
  • (::String) —

    Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.

    | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. |

    Organizations may be queried by directoryCustomerId or by domain, where the domain is a G Suite domain, for example:

    • Query directorycustomerid:123456789 returns Organization resources with owner.directory_customer_id equal to 123456789.
    • Query domain:google.com returns Organization resources corresponding to the domain google.com.