App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::AuthorizedCertificates::Rest::Client (v0.8.0)

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

REST client for the AuthorizedCertificates service.

Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

Inherits

Object

Methods

.configure

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

Configure the AuthorizedCertificates Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all AuthorizedCertificates clients
::Google::Cloud::AppEngine::V1::AuthorizedCertificates::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the AuthorizedCertificates 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

config (Client::Configuration)

Returns

(Client::Configuration)

#create_authorized_certificate

def create_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate
def create_authorized_certificate(parent: nil, certificate: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Uploads the specified SSL certificate.

Overloads

def create_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to create_authorized_certificate via a request object, either of type CreateAuthorizedCertificateRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AppEngine::V1::CreateAuthorizedCertificateRequest, ::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 create_authorized_certificate(parent: nil, certificate: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to create_authorized_certificate 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.
certificate (::Google::Cloud::AppEngine::V1::AuthorizedCertificate, ::Hash) — SSL certificate data.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AppEngine::V1::AuthorizedCertificate)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AppEngine::V1::AuthorizedCertificate)

Raises

(::Google::Cloud::Error) — if the REST call 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::AuthorizedCertificates::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::AppEngine::V1::AuthorizedCertificate.
p result

#delete_authorized_certificate

def delete_authorized_certificate(request, options = nil) -> ::Google::Protobuf::Empty
def delete_authorized_certificate(name: nil) -> ::Google::Protobuf::Empty

Deletes the specified SSL certificate.

Overloads

def delete_authorized_certificate(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_authorized_certificate via a request object, either of type DeleteAuthorizedCertificateRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AppEngine::V1::DeleteAuthorizedCertificateRequest, ::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 delete_authorized_certificate(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_authorized_certificate 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).

Parameter

name (::String) — Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the REST call 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::AuthorizedCertificates::Rest::Client.new

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#get_authorized_certificate

def get_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate
def get_authorized_certificate(name: nil, view: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Gets the specified SSL certificate.

Overloads

def get_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to get_authorized_certificate via a request object, either of type GetAuthorizedCertificateRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AppEngine::V1::GetAuthorizedCertificateRequest, ::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 get_authorized_certificate(name: nil, view: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to get_authorized_certificate 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

name (::String) — Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
view (::Google::Cloud::AppEngine::V1::AuthorizedCertificateView) — Controls the set of fields returned in the GET response.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AppEngine::V1::AuthorizedCertificate)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AppEngine::V1::AuthorizedCertificate)

Raises

(::Google::Cloud::Error) — if the REST call 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::AuthorizedCertificates::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::AppEngine::V1::AuthorizedCertificate.
p result

#initialize

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

Create a new AuthorizedCertificates REST client object.

Yields

(config) — Configure the AuthorizedCertificates client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AppEngine::V1::AuthorizedCertificates::Rest::Client.new

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

#list_authorized_certificates

def list_authorized_certificates(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>
def list_authorized_certificates(parent: nil, view: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>

Lists all SSL certificates the user is authorized to administer.

Overloads

def list_authorized_certificates(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>

Pass arguments to list_authorized_certificates via a request object, either of type ListAuthorizedCertificatesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AppEngine::V1::ListAuthorizedCertificatesRequest, ::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_certificates(parent: nil, view: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>

Pass arguments to list_authorized_certificates 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.
view (::Google::Cloud::AppEngine::V1::AuthorizedCertificateView) — Controls the set of fields returned in the LIST response.
page_size (::Integer) — Maximum results to return per page.
page_token (::String) — Continuation token for fetching the next page of results.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::AuthorizedCertificate>)

Raises

(::Google::Cloud::Error) — if the REST call 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::AuthorizedCertificates::Rest::Client.new

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

# Call the list_authorized_certificates method.
result = client.list_authorized_certificates 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::AuthorizedCertificate.
  p item
end

#update_authorized_certificate

def update_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate
def update_authorized_certificate(name: nil, certificate: nil, update_mask: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

Overloads

def update_authorized_certificate(request, options = nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to update_authorized_certificate via a request object, either of type UpdateAuthorizedCertificateRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AppEngine::V1::UpdateAuthorizedCertificateRequest, ::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 update_authorized_certificate(name: nil, certificate: nil, update_mask: nil) -> ::Google::Cloud::AppEngine::V1::AuthorizedCertificate

Pass arguments to update_authorized_certificate 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

name (::String) — Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
certificate (::Google::Cloud::AppEngine::V1::AuthorizedCertificate, ::Hash) — An AuthorizedCertificate containing the updated resource. Only fields set in the field mask will be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::AppEngine::V1::AuthorizedCertificate)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AppEngine::V1::AuthorizedCertificate)

Raises

(::Google::Cloud::Error) — if the REST call 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::AuthorizedCertificates::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::AppEngine::V1::AuthorizedCertificate.
p result