App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::AuthorizedDomains::Client (v0.6.0)

Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::AuthorizedDomains::Client.

Client for the AuthorizedDomains service.

Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AuthorizedDomains Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AuthorizedDomains clients
::Google::Cloud::AppEngine::V1::AuthorizedDomains::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the AuthorizedDomains Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new AuthorizedDomains client object.

Yields
  • (config) — Configure the AuthorizedDomains client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AppEngine::V1::AuthorizedDomains::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AppEngine::V1::AuthorizedDomains::Client.new do |config|
  config.timeout = 10.0
end

#list_authorized_domains

def list_authorized_domains(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedDomain>
def list_authorized_domains(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedDomain>

Lists all domains the user is authorized to administer.

Overloads 
def list_authorized_domains(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedDomain>
Pass arguments to list_authorized_domains via a request object, either of type ListAuthorizedDomainsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AppEngine::V1::ListAuthorizedDomainsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_authorized_domains(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedDomain>
Pass arguments to list_authorized_domains via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Name of the parent Application resource. Example: apps/myapp.
  • page_size (::Integer) — Maximum results to return per page.
  • page_token (::String) — Continuation token for fetching the next page of results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::AuthorizedDomains::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::ListAuthorizedDomainsRequest.new

# Call the list_authorized_domains method.
result = client.list_authorized_domains request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AppEngine::V1::AuthorizedDomain.
  p item
end