Module: PEClient

Defined in:
lib/pe_client.rb,
lib/pe_client/error.rb,
lib/pe_client/client.rb,
lib/pe_client/version.rb,
lib/pe_client/resource.rb,
lib/pe_client/resources/base.rb,
lib/pe_client/resources/rbac.v1.rb,
lib/pe_client/resources/rbac.v2.rb,
lib/pe_client/resources/puppet.v3.rb,
lib/pe_client/resources/puppet_db.rb,
lib/pe_client/resources/status.v1.rb,
lib/pe_client/resources/metrics.v1.rb,
lib/pe_client/resources/metrics.v2.rb,
lib/pe_client/resources/activity.v1.rb,
lib/pe_client/resources/activity.v2.rb,
lib/pe_client/resources/puppet_ca.v1.rb,
lib/pe_client/resources/rbac.v1/ldap.rb,
lib/pe_client/resources/rbac.v1/saml.rb,
lib/pe_client/resources/rbac.v2/ldap.rb,
lib/pe_client/resources/rbac.v1/roles.rb,
lib/pe_client/resources/rbac.v1/users.rb,
lib/pe_client/resources/rbac.v2/users.rb,
lib/pe_client/resources/base_with_port.rb,
lib/pe_client/resources/rbac.v1/groups.rb,
lib/pe_client/resources/rbac.v1/tokens.rb,
lib/pe_client/resources/rbac.v2/groups.rb,
lib/pe_client/resources/rbac.v2/tokens.rb,
lib/pe_client/resources/code_manager.v1.rb,
lib/pe_client/resources/orchestrator.v1.rb,
lib/pe_client/resources/puppet_admin.v1.rb,
lib/pe_client/resources/node_inventory.v1.rb,
lib/pe_client/resources/rbac.v1/passwords.rb,
lib/pe_client/resources/node_classifier.v1.rb,
lib/pe_client/resources/puppet_db/admin.v1.rb,
lib/pe_client/resources/puppet_db/query.v4.rb,
lib/pe_client/resources/rbac.v1/disclaimer.rb,
lib/pe_client/resources/rbac.v1/permissions.rb,
lib/pe_client/resources/orchestrator.v1/jobs.rb,
lib/pe_client/resources/orchestrator.v1/plans.rb,
lib/pe_client/resources/orchestrator.v1/tasks.rb,
lib/pe_client/resources/puppet.v3/file_bucket.rb,
lib/pe_client/resources/puppet_db/metadata.v1.rb,
lib/pe_client/resources/orchestrator.v1/scopes.rb,
lib/pe_client/resources/orchestrator.v1/command.rb,
lib/pe_client/resources/puppet.v3/file_metadata.rb,
lib/pe_client/resources/node_classifier.v1/nodes.rb,
lib/pe_client/resources/node_classifier.v1/rules.rb,
lib/pe_client/resources/puppet_db/query.v4/nodes.rb,
lib/pe_client/resources/node_classifier.v1/groups.rb,
lib/pe_client/resources/orchestrator.v1/inventory.rb,
lib/pe_client/resources/orchestrator.v1/plan_jobs.rb,
lib/pe_client/resources/node_classifier.v1/classes.rb,
lib/pe_client/resources/puppet_db/admin.v1/archive.rb,
lib/pe_client/resources/puppet_db/query.v4/reports.rb,
lib/pe_client/resources/node_classifier.v1/commands.rb,
lib/pe_client/resources/puppet_db/query.v4/catalogs.rb,
lib/pe_client/resources/puppet_db/query.v4/factsets.rb,
lib/pe_client/resources/node_classifier.v1/validation.rb,
lib/pe_client/resources/orchestrator.v1/scheduled_jobs.rb,
lib/pe_client/resources/node_classifier.v1/environments.rb,
lib/pe_client/resources/puppet_ca.v1/certificate_status.rb,
lib/pe_client/resources/puppet_ca.v1/certificate_request.rb,
lib/pe_client/resources/node_classifier.v1/classification.rb,
lib/pe_client/resources/node_classifier.v1/group_children.rb,
lib/pe_client/resources/node_classifier.v1/update_classes.rb,
lib/pe_client/resources/puppet_ca.v1/bulk_certificate_sign.rb,
lib/pe_client/resources/node_classifier.v1/import_hierarchy.rb,
lib/pe_client/resources/node_classifier.v1/last_class_update.rb,
lib/pe_client/resources/puppet_ca.v1/certificate_revocation_list.rb

Overview

Copyright 2025 Perforce Software Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Modules: Resource Classes: BadRequestError, Client, ConflictError, Error, ForbiddenError, HTTPError, NotFoundError, ServerError, UnauthorizedError

Constant Summary collapse

VERSION =

PEClient version

"0.2.0"

Class Method Summary collapse

Class Method Details

.deprecated(old_method, new_method) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Deprecation warnings

Parameters:

  • old_method (String) —

    The name of the deprecated method

  • new_method (String) —

    The name of the new method to use



44
45
46
 
# File 'lib/pe_client.rb', line 44

def self.deprecated(old_method, new_method)
  warn "[DEPRECATION] `#{old_method}` is deprecated. Please use `#{new_method}` instead."
end

.new(api_key:, base_url:, ca_file:, &block) {|Faraday::Connection| ... } ⇒ Object

Convenience method to create a new PEClient::Client

Parameters:

  • api_key (String) —

    API key for authentication

  • base_url (String, URI) —

    Base URL for the PE API

  • ca_file (String) —

    Path to CA certificate file

  • block (Proc) —

    Optional block for Faraday connection customization

Yields:

  • (Faraday::Connection) —

    Faraday connection for customization

See Also:



33
34
35
 
# File 'lib/pe_client.rb', line 33

def self.new(api_key:, base_url:, ca_file:, &block)
  Client.new(api_key:, base_url:, ca_file:, &block)
end