fastly-api-client
API
Generated with
fastly-api-client/com.gu.fastly.api/FastlyApiClient

FastlyApiClient

com.gu.fastly.api.FastlyApiClient
case class FastlyApiClient(apiKey: String, serviceId: String, config: Option[AsyncHttpClientConfig], proxyServer: Option[ProxyServer])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Classlikes

object DELETE extends HttpMethod

Attributes

Supertypes
trait HttpMethod
class Object
trait Matchable
class Any
Self type
DELETE.type
object GET extends HttpMethod

Attributes

Supertypes
trait HttpMethod
class Object
trait Matchable
class Any
Self type
GET.type
sealed trait HttpMethod

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DELETE
object GET
object POST
object PUT
object POST extends HttpMethod

Attributes

Supertypes
trait HttpMethod
class Object
trait Matchable
class Any
Self type
POST.type
object PUT extends HttpMethod

Attributes

Supertypes
trait HttpMethod
class Object
trait Matchable
class Any
Self type
PUT.type

Value members

Concrete methods

def backendCheckAll(version: Int): Future[Response]
def backendCreate(version: Int, id: String, address: String, port: Int): Future[Response]
def backendList(version: Int): Future[Response]
def closeConnectionPool(): Unit
def packageUpload(serviceId: String, versionId: Int, `package`: File): Future[Response]

Upload a Compute@Edge package Endpoint: PUT /service/:service_id/version/:version_id/package Official documentation: https://developer.fastly.com/reference/api/services/package/

Upload a Compute@Edge package Endpoint: PUT /service/:service_id/version/:version_id/package Official documentation: https://developer.fastly.com/reference/api/services/package/

Value parameters

package

The Compute@Edge package to upload to the Fastly API endpoint. This is a .tar.gz file that is generated by running the Fastly CLI with the command fastly compute build. The package is created in the pkg/ folder within your Compute@Edge project.

serviceId

The ID of the Fastly service

versionId

The version number of the service

Attributes

def purge(url: String, extraHeaders: Map[String, String]): Future[Response]
def purgeAll(): Future[Response]
def purgeKey(key: String, extraHeaders: Map[String, String]): Future[Response]
def serviceList(): Future[Response]
def stats(from: Instant, to: Instant, by: Value, region: Value): Future[Response]
def statsAggregate(from: Instant, to: Instant, by: Value, region: Value): Future[Response]
def statsForService(from: Instant, to: Instant, by: Value, region: Value, serviceId: String): Future[Response]
def statsForServiceWithFieldFilter(from: Instant, to: Instant, by: Value, region: Value, serviceId: String, field: String): Future[Response]
def statsRegions(): Future[Response]
def statsUsage(from: Instant, to: Instant, by: Value, region: Value): Future[Response]
def statsUsageGroupedByService(from: Instant, to: Instant, by: Value, region: Value): Future[Response]
def statsWithFieldFilter(from: Instant, to: Instant, by: Value, region: Value, field: String): Future[Response]
def vclDelete(version: Int, name: String): Future[Response]
def vclList(version: Int): Future[Response]
def vclSetAsMain(version: Int, name: String): Future[Response]
def vclUpdate(version: Int, vcl: Map[String, String]): List[Future[Response]]
def vclUpload(version: Int, vcl: String, id: String, name: String): Future[Response]
def versionActivate(version: Int): Future[Response]
def versionClone(version: Int): Future[Response]
def versionComment(version: Int, comment: String): Future[Response]

Update an existing version with a comment that will appear in the Fastly web interface. Endpoint: PUT /service/:service_id/version/:version Official documentation: https://developer.fastly.com/reference/api/services/version/

Update an existing version with a comment that will appear in the Fastly web interface. Endpoint: PUT /service/:service_id/version/:version Official documentation: https://developer.fastly.com/reference/api/services/version/

Value parameters

comment

A freeform descriptive note. This will appear in the service summary.

version

Integer identifying a service version.

Attributes

def versionCreate(): Future[Response]
def versionList(): Future[Response]
def versionValidate(version: Int): Future[Response]

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with