Documentation

ImageCreate extends BaseEndpoint implements Endpoint Uses EndpointTrait

Interfaces, Classes and Traits

Endpoint

Table of Contents

$body  : mixed
$headerParameters  : mixed
$queryParameters  : mixed
__construct()  : mixed
Create an image by either pulling it from a registry or importing it.
getAuthenticationScopes()  : array<string|int, mixed>
Get security scopes of an endpoint.
getBody()  : array<string|int, mixed>
Get body for an endpoint.
getExtraHeaders()  : array<string|int, mixed>
getHeaders()  : array<string|int, mixed>
Get the headers of an endpoint.
getMethod()  : string
Get the HTTP method of an endpoint (like GET, POST, ...).
getQueryString()  : string
Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).
getUri()  : string
Get the URI of an endpoint (like /foo-uri).
parseResponse()  : mixed
getFormBody()  : array<string|int, mixed>
getFormOptionsResolver()  : OptionsResolver
getHeadersOptionsResolver()  : OptionsResolver
getMultipartBody()  : array<string|int, mixed>
getQueryOptionsResolver()  : OptionsResolver
getSerializedBody()  : array<string|int, mixed>
transformResponseBody()  : null

Properties

$headerParameters

protected mixed $headerParameters = []

Methods

__construct()

Create an image by either pulling it from a registry or importing it.

public __construct(string $inputImage[, array<string|int, mixed> $queryParameters = [] ][, array<string|int, mixed> $headerParameters = [] ]) : mixed
Parameters
$inputImage : string

Image content if the value - has been specified in fromSrc query parameter

$queryParameters : array<string|int, mixed> = []

{

@var string $fromImage Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.
@var string $fromSrc Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.
@var string $repo Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.
@var string $tag Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.
@var string $message set commit message for imported image
@var string $platform Platform in the format os[/arch[/variant]]

}

$headerParameters : array<string|int, mixed> = []

{

@var string $X-Registry-Auth A base64url-encoded auth configuration.

details.

}

Return values
mixed —

getAuthenticationScopes()

Get security scopes of an endpoint.

public getAuthenticationScopes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBody()

Get body for an endpoint.

public getBody(SerializerInterface $serializer[, mixed $streamFactory = null ]) : array<string|int, mixed>

Return value consist of an array where the first item will be a list of headers to add on the request (like the Content Type) And the second value consist of the body object.

Parameters
$serializer : SerializerInterface
$streamFactory : mixed = null
Return values
array<string|int, mixed> —

getExtraHeaders()

public getExtraHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getHeaders()

Get the headers of an endpoint.

public getHeaders([array<string|int, mixed> $baseHeaders = [] ]) : array<string|int, mixed>
Parameters
$baseHeaders : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getMethod()

Get the HTTP method of an endpoint (like GET, POST, ...).

public getMethod() : string
Return values
string —

getQueryString()

Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).

public getQueryString() : string
Return values
string —

getUri()

Get the URI of an endpoint (like /foo-uri).

public getUri() : string
Return values
string —

parseResponse()

public parseResponse(ResponseInterface $response, SerializerInterface $serializer[, string $fetchMode = Client::FETCH_OBJECT ]) : mixed
Parameters
$response : ResponseInterface
$serializer : SerializerInterface
$fetchMode : string = Client::FETCH_OBJECT
Return values
mixed —

getFormBody()

protected getFormBody() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFormOptionsResolver()

protected getFormOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getHeadersOptionsResolver()

protected getHeadersOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getMultipartBody()

protected getMultipartBody([mixed $streamFactory = null ]) : array<string|int, mixed>
Parameters
$streamFactory : mixed = null
Return values
array<string|int, mixed> —

getQueryOptionsResolver()

protected getQueryOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getSerializedBody()

protected getSerializedBody(SerializerInterface $serializer) : array<string|int, mixed>
Parameters
$serializer : SerializerInterface
Return values
array<string|int, mixed> —

Search results