class CB::Client

• CB::Client
• Reference
• Object

Defined in:

client/account.cr
client/backup.cr
client/client.cr
client/cluster.cr
client/config_param.cr
client/firewall_rule.cr
client/log_destination.cr
client/network.cr
client/peering.cr
client/providers.cr
client/role.cr
client/session.cr
client/session_intent.cr
client/team.cr
client/team_member.cr

Constructors

• .new(host : String = CB::HOST, bearer_token : String | Nil = nil)

Instance Method Summary

• #add_log_destination(cluster_id, ld)

  Add a logger to a cluster.

• #backup_list(id : Identifier)
• #backup_start(id : Identifier)
• #backup_token(id : Identifier)
• #create_cluster(params : ClusterCreateParams)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clusters/post

• #create_firewall_rule(network_id, params : FirewallRuleCreateParams)

  Add a firewall rule to a network.

• #create_fork(params : ForkCreateParams)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridforks/post

• #create_peering(network_id, params : PeeringCreateParams)
• #create_replica(params : ReplicaCreateParams)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridreplicas/create-cluster-replica

• #create_role(cluster_id : Identifier)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridroles/create-role

• #create_role(cluster_id)
• #create_session(params : SessionCreateParams)

  https://crunchybridgeapiinternal.docs.apiary.io/#reference/0/sessions/create-session

• #create_session_intent(params : SessionIntentCreateParams)
• #create_team(name : String)

  Create a new team.

• #create_team_member(team_id, params : TeamMemberCreateParams)

  Create (add) a team member.

• #delete(path)
• #delete_peering(network_id, peering_id)
• #delete_role(cluster_id, role_name)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/delete-role

• #destroy_cluster(id : String)
• #destroy_cluster(id : Identifier)
• #destroy_firewall_rule(network_id, firewall_rule_id)

  Remove a firewall rule from a network.

• #destroy_log_destination(cluster_id, logdest_id)

  Remove a logger from a cluster.

• #destroy_team(id)

  Delete a team.

• #detach_cluster(id : Identifier)
• #disable_ha(id : Identifier) : CB::Model::Operation | Nil

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsdisable-ha/disable-high-availability

• #enable_ha(id : Identifier) : CB::Model::Operation | Nil

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsenable-ha/enable-high-availability

• #exec(method, path, body : String | Nil = nil)
• #exec(method, path, body)
• #flatten_clusters(clusters : Array(CB::Model::Cluster) | Nil, result = [] of CB::Model::Cluster)
• #get(path)
• #get_access_token : CB::Model::AccessToken
• #get_account(secret : String | Nil = nil)

  Get the account for the currently logged in user.

• #get_cluster(id : Identifier)

  Retrieve the cluster by id or by name.

• #get_cluster(id : String | Nil)

  TODO (abrightwell): track down why this must be nilable.

• #get_cluster_status(cluster_id)
• #get_clusters(teams : Array(CB::Model::Team), flatten : Bool = false)
• #get_clusters(team_id)
• #get_clusters
• #get_configuration_parameter(id : Identifier, name : String)

  Get configuration parameter value

• #get_firewall_rules(network_id)

  List current firewall rules for a network.

• #get_log_destinations(cluster_id)

  List existing loggers for a cluster.

• #get_network(id : Identifier)

  Get a network by id or name.

• #get_network(id : String | Nil)
• #get_networks(team : Identifier | Nil)

  Get all networks for a team.

• #get_networks(teams : Array(CB::Model::Team))
• #get_peering(network_id, peering_id)
• #get_providers

  List available providers.

• #get_role(cluster_id : Identifier, role_name : String)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/get-role

• #get_role(cluster_id, role_name)
• #get_session_intent(params : SessionIntentGetParams)
• #get_team(id)

  Retrieve details about a team.

• #get_team_cert(id)
• #get_team_member(team_id, account_id)

  Retrieve details about a team member.

• #get_teams

  List available teams.

• #get_tempkey(id : Identifier)
• #headers : HTTP::Headers
• #headers=(headers : HTTP::Headers)
• #host : String
• #host=(host : String)
• #http : HTTP::Client
• #list_configuration_parameters(id : Identifier)

  List configuration parameter values.

• #list_peerings(network_id)
• #list_roles(cluster_id)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridroles/list-roles

• #list_supported_configuration_parameters

  List support configuration parameters

• #list_team_members(team_id)

  List the memebers of a team.

• #patch(path, body)
• #post(path, body = nil)
• #put(path, body = nil)
• #remove_team_member(team_id, account_id)

  Remove a team member from a team.

• #restart_cluster(id, service : String)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrestart/restart-cluster

• #resume_cluster(id : Identifier)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsresume/resume-cluster

• #suspend_cluster(id : Identifier)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionssuspend/suspend-cluster

• #update_cluster(cluster_id, body)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusterid/update-cluster

• #update_configuration_parameters(id, parameters, allow_restart : Bool = false)

  Update configuration parameter values.

• #update_firewall_rule(network_id, firewall_rule_id, params : FirewallRuleUpdateParams)

  Update a firewall rule for a network.

• #update_role(cluster_id, role_name, ur)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/update-role

• #update_team(id, options)

  Update a team.

• #update_team_member(team_id, account_id, role)

  Update a team member.

• #update_upgrade_cluster(uc)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/update-upgrade-cluster

• #upgrade_cluster(uc)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/upgrade-cluster

• #upgrade_cluster_cancel(id)
• #upgrade_cluster_status(id)

  https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/get-upgrade-status

Constructor Detail

Instance Method Detail