Class: Google::Apis::PubliccaV1::PublicCertificateAuthorityService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/publicca_v1/service.rb

Overview

Public Certificate Authority API

The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.

Examples:

require 'google/apis/publicca_v1'

Publicca = Google::Apis::PubliccaV1 # Alias the module
service = Publicca::PublicCertificateAuthorityService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://publicca.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PublicCertificateAuthorityService

Returns a new instance of PublicCertificateAuthorityService.



49
50
51
52
53
54
 
# File 'lib/google/apis/publicca_v1/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-publicca_v1',
        client_version: Google::Apis::PubliccaV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



42
43
44
 
# File 'lib/google/apis/publicca_v1/service.rb', line 42

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



47
48
49
 
# File 'lib/google/apis/publicca_v1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#create_project_location_external_account_key(parent, external_account_key_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubliccaV1::ExternalAccountKey

Creates a new ExternalAccountKey bound to the project.

Parameters:

  • parent (String) —

    Required. The parent resource where this external_account_key will be created. Format: projects/[project_id]/locations/[location]. At present only the " global" location is supported.

  • external_account_key_object (Google::Apis::PubliccaV1::ExternalAccountKey) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/publicca_v1/service.rb', line 79

def (parent,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/externalAccountKeys', options)
  command.request_representation = Google::Apis::PubliccaV1::ExternalAccountKey::Representation
  command.request_object = 
  command.response_representation = Google::Apis::PubliccaV1::ExternalAccountKey::Representation
  command.response_class = Google::Apis::PubliccaV1::ExternalAccountKey
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end