Class: Google::Cloud::ResourceManager::V3::SearchOrganizationsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcemanager/v3/organizations.rb

Overview

The request sent to the SearchOrganizations method.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns 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.



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/organizations.rb', line 117

class SearchOrganizationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/organizations.rb', line 117

class SearchOrganizationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::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.


117
118
119
120
 
# File 'proto_docs/google/cloud/resourcemanager/v3/organizations.rb', line 117

class SearchOrganizationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end