Class: IBM::Cloud::SDK::VPC::VPCCollection

Inherits:

IBM::Cloud::SDKHTTP::BaseCollection

• Object
• IBM::Cloud::SDKHTTP::BaseCollection
• IBM::Cloud::SDK::VPC::VPCCollection

Includes:

VpcHTTP

Defined in:

lib/ibm/cloud/sdk/vpc/http/vpc_collection.rb

Overview

Container that encapsulates the VPC API. This class is used as a base for collection APIs.

Direct Known Subclasses

FloatingIPs, FlowLogCollectors, IKEPolicies, INSTANCE::Actions, INSTANCE::FloatingIps, INSTANCE::NetworkInterfaces, INSTANCE::VolumeAttachments, IPSecPolicies, Images, InstanceProfiles, Instances, Keys, LOADBALANCER::Listeners, LOADBALANCER::Policies, LOADBALANCER::Rules, LoadBalancers, Members, NETWORKACL::Rules, NetworkACLs, OperatingSystems, Pools, PublicGateways, Regions, SECURITYGROUP::NetworkInterfaces, SECURITYGROUP::Rules, SecurityGroups, Subnets, IBM::Cloud::SDK::VPC::VPCS::AddressPrefixes, IBM::Cloud::SDK::VPC::VPCS::Routes, IBM::Cloud::SDK::VPC::VPNGATEWAY::Connections, IBM::Cloud::SDK::VPC::VPNGATEWAY::LocalCIDRs, IBM::Cloud::SDK::VPC::VPNGATEWAY::PeerCIDRs, VPNGateways, VolumeProfiles, Volumes, Vpcs, Zones

Instance Attribute Summary

Attributes included from IBM::Cloud::SDKHTTP::BaseHTTPMixin

#endpoint

Attributes inherited from IBM::Cloud::SDKHTTP::BaseCollection

#connection, #endpoint, #logger, #token

Instance Method Summary

• #count ⇒ Integer

  Get the total count if it exists in the response.

• #has_count? ⇒ Boolean

  Determine if the collection has a total_count key in its response.

• #params(start: nil, limit: nil, resource_group: nil) ⇒ BaseCollection

  A chainable method to set query filters on the collection.

Methods included from VpcHTTP

#metadata

Methods included from IBM::Cloud::SDKHTTP::BaseHTTPMixin

#adhoc, #delete, #get, #metadata, #patch, #post, #put, #unchecked_response, #url

Methods inherited from IBM::Cloud::SDKHTTP::BaseCollection

#all, #create, #data, #fetch, #initialize, #reset_params

Constructor Details

This class inherits a constructor from IBM::Cloud::SDKHTTP::BaseCollection

Instance Method Details

#count ⇒ Integer

Get the total count if it exists in the response. Returns nil otherwise.

Returns:

• (Integer) —

  The total count reuturned by the server.

# File 'lib/ibm/cloud/sdk/vpc/http/vpc_collection.rb', line 42

def count
  fetch.json&.[](:total_count)
end

#has_count? ⇒ Boolean

Determine if the collection has a total_count key in its response.

Returns:

• (Boolean)

# File 'lib/ibm/cloud/sdk/vpc/http/vpc_collection.rb', line 36

def has_count?
  fetch.json&.key?(:total_count)
end

#params(start: nil, limit: nil, resource_group: nil) ⇒ BaseCollection

A chainable method to set query filters on the collection.

Examples:

vpc.images.params(limit: 1).all

Parameters:

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

  A server-supplied token determining what resource to start the page on.

• limit (Integer) (defaults to: nil) —

  The number of resources to return on a page allowed values are between 1 and 100

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

  Filters the collection to resources within one of the resource groups identified in a comma-separated list of resource group identifiers

Returns:

• (BaseCollection) —

  This class with the param instance variable set.

# File 'lib/ibm/cloud/sdk/vpc/http/vpc_collection.rb', line 27

def params(start: nil, limit: nil, resource_group: nil)
  @params[:start] = start if start
  @params[:limit] = limit if limit
  @params[:resource_group] = resource_group if resource_group
  self
end