Class ReportClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Report, ReportJson>

com.eqixiac.equinix.customerportal.client.internal.implementation.ReportClientImpl

All Implemented Interfaces:

Pageable<Report>, PageablePost<Report>, ReportClient<Report>

public class ReportClientImpl
extends ResourceClientBase<Report, ReportJson>
implements ReportClient<Report>

Nested Class Summary

Nested classes/interfaces inherited from class ClientBase

ClientBase.EquinixRequestBuilder

Modifier and Type	Class	Description
protected class	ClientBase.EquinixRequestBuilder	Fluent builder for constructing EquinixRequest instances.

Constructor Summary

Constructors

Constructor	Description
ReportClientImpl(CustomerPortalConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
List<? extends Report>	deleteReports(List<String> reportIds)
boolean	deleteScheduledReports(List<String> scheduledIds)
byte[]	downloadReport(String reportId)
byte[]	downloadReports(List<String> reportIds)
ReportJson	generateReport(String scheduledId)
ReportJson	getReportById(String reportId)
ReportDefinitionJson	getReportDefinition(String reportName)
List<ReportDefinitionJson>	getReportDefinitions()
Page<ReportJson>	getReports()
Page<ReportJson>	getReports(Map<String, List<String>> queryParams)
ScheduledReportJson	getScheduledReport(String scheduledId)
List<? extends ScheduledReport>	getScheduledReports()
ScheduledReportJson	scheduleReport(ScheduleReportRequest request)
ScheduledReportJson	updateScheduledReport(String scheduledId, ScheduleReportRequest request)
protected Report	wrap(ReportJson json)	Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Methods inherited from class ResourceClientBase

createOne, deleteOne, deleteOne, deleteOneByUuid, dryRunCreate, dryRunCreate, dryRunPatch, dryRunUpdate, getOne, getOne, getOneByUuid, listPage, listPage, listPage, listPagePath, nextPage, nextPage, patchOne, patchOne, postOne, postOne, postOne, searchPage, searchPage, searchPageQueryPaginated, searchPageQueryPaginated, updateOne, updateOne, updateOneByUuid

Modifier and Type	Method	Description
protected ReportJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected ReportJson	deleteOne(String serviceEndpoint, String uuid)
protected ReportJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected ReportJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected ReportJson	dryRunCreate(String serviceEndpoint, Object body)
protected ReportJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ReportJson	dryRunPatch(String serviceEndpoint, String uuid, List<PatchOperation> operations)	Dry-run variant of ResourceClientBase.patchOne(String, String, List): sends the identical RFC 6902 JSON Patch request (same application/json-patch+json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected ReportJson	dryRunUpdate(String serviceEndpoint, String uuid, Object body)	Dry-run variant of ResourceClientBase.updateOne(String, String, Object): sends the identical update request (same default application/json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected ReportJson	getOne(String serviceEndpoint, String uuid)
protected ReportJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected ReportJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<ReportJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<ReportJson>	listPage(String serviceEndpoint)
protected Page<ReportJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<ReportJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Report>	nextPage(PaginatedPostRequest<Report> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Report>	nextPage(PaginatedRequest<Report> equinixRequest)
protected ReportJson	patchOne(String serviceEndpoint, String uuid, List<PatchOperation> operations)	PATCH a resource by uuid with an RFC 6902 JSON Patch operations array, sent with content-type application/json-patch+json.
protected ReportJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected ReportJson	postOne(String serviceEndpoint, Object creatorBody)
protected ReportJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ReportJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<ReportJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<ReportJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<ReportJson>	searchPageQueryPaginated(String serviceEndpoint, Object filterBody)	POST search whose pagination travels as offset/limit query parameters (per the endpoint's spec) rather than inside the body - e.g. assets v1 and the EIA services/prices searches.
protected Page<ReportJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected ReportJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected ReportJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected ReportJson	updateOneByUuid(String uuid, Object body)	update(uuid, body) via the derived Update<Singular> endpoint name.

Methods inherited from class ClientBase

booleanOp, buildRequest, buildRequest, buildRequestWithPathParams, buildRequestWithQueryParams, bytesOp, createReturningLocationUuid, getAs, getAs, getConfigClient, invoke, listAs, mapOp, newRequest, postAs, postForType, postForType, postForType, postListAs, stringOp, voidOp

Modifier and Type	Method	Description
protected boolean	booleanOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected byte[]	bytesOp(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams)
protected String	createReturningLocationUuid(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	POST a body, then return the created resource's uuid parsed from the response Location header (for endpoints that return 201 Location: .../{uuid} rather than a body).
protected <R> R	getAs(String serviceEndpoint, Class<R> responseType)
protected <R> R	getAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> responseType)
protected Config	getConfigClient()
protected <T> EquinixResponse<T>	invoke(EquinixRequest<T> equinixRequest)
protected <R> List<R>	listAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> elementType)
protected Map<String,String>	mapOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected ClientBase.EquinixRequestBuilder	newRequest(String serviceEndpoint)	Creates a fluent request builder for the given service endpoint.
protected <R> R	postAs(String serviceEndpoint, Object body, Class<R> responseType)
protected <R> R	postForType(String serviceEndpoint, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> List<R>	postListAs(String serviceEndpoint, Object body, Class<R> elementType)
protected String	stringOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected void	voidOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	Execute a request for its side effect only - the response body is validated (throws on API error) and discarded.

Methods inherited from class Object

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

Constructor Details

ReportClientImpl

public ReportClientImpl(CustomerPortalConfigImpl configClient)

Method Details

wrap

protected Report wrap(ReportJson json)

Description copied from class: ResourceClientBase

Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Specified by:

wrap in class ResourceClientBase<Report, ReportJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

getReports

public Page<ReportJson> getReports()

Specified by:

getReports in interface ReportClient<Report>

getReports

public Page<ReportJson> getReports(Map<String, List<String>> queryParams)

Specified by:

getReports in interface ReportClient<Report>

getReportById

public ReportJson getReportById(String reportId)

Specified by:

getReportById in interface ReportClient<Report>

deleteReports

public List<? extends Report> deleteReports(List<String> reportIds)

Specified by:

deleteReports in interface ReportClient<Report>

downloadReports

public byte[] downloadReports(List<String> reportIds)

Specified by:

downloadReports in interface ReportClient<Report>

getScheduledReports

public List<? extends ScheduledReport> getScheduledReports()

Specified by:

getScheduledReports in interface ReportClient<Report>

scheduleReport

public ScheduledReportJson scheduleReport(ScheduleReportRequest request)

Specified by:

scheduleReport in interface ReportClient<Report>

deleteScheduledReports

public boolean deleteScheduledReports(List<String> scheduledIds)

Specified by:

deleteScheduledReports in interface ReportClient<Report>

getScheduledReport

public ScheduledReportJson getScheduledReport(String scheduledId)

Specified by:

getScheduledReport in interface ReportClient<Report>

updateScheduledReport

public ScheduledReportJson updateScheduledReport(String scheduledId,
 ScheduleReportRequest request)

Specified by:

updateScheduledReport in interface ReportClient<Report>

generateReport

public ReportJson generateReport(String scheduledId)

Specified by:

generateReport in interface ReportClient<Report>

getReportDefinitions

public List<ReportDefinitionJson> getReportDefinitions()

Specified by:

getReportDefinitions in interface ReportClient<Report>

getReportDefinition

public ReportDefinitionJson getReportDefinition(String reportName)

Specified by:

getReportDefinition in interface ReportClient<Report>

downloadReport

public byte[] downloadReport(String reportId)

Specified by:

downloadReport in interface ReportClient<Report>