Class: Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb

Overview

REST client for the PublicCertificateAuthorityService service.

Manages the resources required for ACME external account binding for the public certificate authority service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#external_account_key_path, #location_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new PublicCertificateAuthorityService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the PublicCertificateAuthorityService client.

Yield Parameters:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb', line 134

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @public_certificate_authority_service_stub = ::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the PublicCertificateAuthorityService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all PublicCertificateAuthorityService clients
::Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Security", "PublicCA", "V1beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the PublicCertificateAuthorityService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



104
105
106
107
 
# File 'lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb', line 104

def configure
  yield @config if block_given?
  @config
end

#create_external_account_key(request, options = nil) ⇒ ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey #create_external_account_key(parent: nil, external_account_key: nil) ⇒ ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

Creates a new ExternalAccountKey bound to the project.

Examples:

Basic example

require "google/cloud/security/public_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PublicCA::V1beta1::PublicCertificateAuthorityService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest.new

# Call the create_external_account_key method.
result = client. request

# The returned object is of type Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey.
p result

Overloads:

  • #create_external_account_key(request, options = nil) ⇒ ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

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

    Parameters:

    • request (::Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_external_account_key(parent: nil, external_account_key: nil) ⇒ ::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey

    Pass arguments to create_external_account_key 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) (defaults to: nil) —

      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 (::Google::Cloud::Security::PublicCA::V1beta1::ExternalAccountKey, ::Hash) (defaults to: nil) —

      Required. The external account key to create. This field only exists to future-proof the API. At present, all fields in ExternalAccountKey are output only and all values are ignored. For the purpose of the CreateExternalAccountKeyRequest, set it to a default/empty value.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb', line 217

def  request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PublicCA::V1beta1::CreateExternalAccountKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PublicCA::V1beta1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs..retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @public_certificate_authority_service_stub. request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


114
115
116
 
# File 'lib/google/cloud/security/public_ca/v1beta1/public_certificate_authority_service/rest/client.rb', line 114

def universe_domain
  @public_certificate_authority_service_stub.universe_domain
end