LogStreams
extends ManagementEndpoint
in package
implements
LogStreamsInterface
Class LogStreams.
Handles requests to the Log Streams endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- LogStreamsInterface
- Interface LogStreamsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- create() : ResponseInterface
- Create a new Log Stream.
- delete() : ResponseInterface
- Deletes a Log Stream.
- get() : ResponseInterface
- Get a single Log Stream.
- getAll() : ResponseInterface
- Get all Log Streams.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- instance() : static
- update() : ResponseInterface
- Updates an existing Log Stream.
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —create()
Create a new Log Stream.
public
create(string $type, array<string|int, mixed> $sink[, string|null $name = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: create:log_streams.
Parameters
- $type : string
-
the type of log stream being created
- $sink : array<string|int, mixed>
-
the type of log stream determines the properties required in the sink payload; see the linked documentation
- $name : string|null = null
-
Optional. The name of the log stream.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —delete()
Deletes a Log Stream.
public
delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: delete:log_streams.
Parameters
- $id : string
-
ID of the Log Stream to delete
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —get()
Get a single Log Stream.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:log_streams.
Parameters
- $id : string
-
log Stream ID to query
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getAll()
Get all Log Streams.
public
getAll([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:log_streams.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient
Return values
static —update()
Updates an existing Log Stream.
public
update(string $id, array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:log_streams.
Parameters
- $id : string
-
ID of the Log Stream to update
- $body : array<string|int, mixed>
-
Log Stream data to update. Only certain fields are update-able; see the linked documentation.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)