Class Projects

java.lang.Object

com.eqixiac.equinix.EquinixClient

com.eqixiac.equinix.Projects

All Implemented Interfaces:

Closeable, AutoCloseable

public final class Projects
extends EquinixClient

The primary entry point for accessing Equinix Projects APIs.

Projects are read-only organizational containers associated with a root organization, grouping related Equinix infrastructure components under named projects.

All resource accessors use lazy initialization - internal clients are created on first access and reused for subsequent calls.

Quick Start

BasicEquinixCredentials credentials = new BasicEquinixCredentials("clientId", "clientSecret");
Projects projects = new Projects(credentials);

// List all projects
PaginatedList<Project> projectList = projects.projects().list();

Author:

ianjones

See Also:

• BasicEquinixCredentials

Field Summary

Fields inherited from class EquinixClient

autoLoadMetros, enrichMetroRegistry, equinixClient, peeringDbApiKey

Modifier and Type	Field	Description
protected final boolean	autoLoadMetros	Whether an explicit EquinixClient.authenticate() should eagerly load the metro catalog.
protected final boolean	enrichMetroRegistry	Whether the metro registry should be enriched with per-IBX detail from EIA.
protected final EquinixClient	equinixClient
protected final String	peeringDbApiKey	The PeeringDB API key configured via EquinixConfig.getPeeringDbApiKey(), or null when none was configured.

Constructor Summary

Constructors

Constructor	Description
Projects(EquinixCredentials equinixCredentials)	Creates a new Projects client using the provided credentials.
Projects(EquinixCredentials equinixCredentials, boolean isSandBoxed)	Creates a new Projects client with optional sandbox mode.
Projects(EquinixCredentialsProvider credentialsProvider)	Creates a new Projects client whose credentials are resolved through the given provider.
Projects(EquinixCredentialsProvider credentialsProvider, boolean isSandBoxed)	Creates a new Projects client over a custom credentials provider, with optional sandbox mode.
Projects(EquinixCredentialsProvider credentialsProvider, EquinixConfig config)	Creates a new Projects client over a custom credentials provider with explicit EquinixConfig options.
Projects(EquinixCredentials equinixCredentials, EquinixConfig config)	Creates a new Projects client with explicit EquinixConfig options.

Method Summary

Modifier and Type	Method	Description
ProjectList	projects()	Returns the client for listing Equinix projects.

Methods inherited from class EquinixClient

authenticate, close, core

Modifier and Type	Method	Description
void	authenticate()	Explicitly obtains a token from the configured source (an OAuth2 client-credentials mint, or the BearerTokenProvider) and stores it for subsequent API calls.
void	close()
protected Core	core()	Returns the internal core client for authentication and platform-level operations.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Projects

public Projects(EquinixCredentials equinixCredentials)

Creates a new Projects client using the provided credentials. Authentication occurs automatically on the first API call.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

Projects

public Projects(EquinixCredentials equinixCredentials,
 boolean isSandBoxed)

Creates a new Projects client with optional sandbox mode.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Projects

public Projects(EquinixCredentialsProvider credentialsProvider)

Creates a new Projects client whose credentials are resolved through the given provider. Authentication occurs automatically on the first API call.

Parameters:

credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs

Projects

public Projects(EquinixCredentialsProvider credentialsProvider,
 boolean isSandBoxed)

Creates a new Projects client over a custom credentials provider, with optional sandbox mode.

Parameters:

credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Projects

public Projects(EquinixCredentials equinixCredentials,
 EquinixConfig config)

Creates a new Projects client with explicit EquinixConfig options.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

config - the construction-time options

Projects

public Projects(EquinixCredentialsProvider credentialsProvider,
 EquinixConfig config)

Creates a new Projects client over a custom credentials provider with explicit EquinixConfig options.

Parameters:

credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs

config - the construction-time options

Method Details

projects

public ProjectList projects()

Returns the client for listing Equinix projects. Projects are read-only organizational containers for grouping related infrastructure resources.

Returns:

the ProjectList client for listing projects