Documentation

Google_Service_Logging_Resource_BillingAccountsSinks extends Google_Service_Resource
in package

The "sinks" collection of methods.

Typical usage is: $loggingService = new Google_Service_Logging(...); $sinks = $loggingService->sinks;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Logging_LogSink
Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. (sinks.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Logging_LoggingEmpty
Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. (sinks.delete)
get()  : Google_Service_Logging_LogSink
Gets a sink. (sinks.get)
listBillingAccountsSinks()  : Google_Service_Logging_ListSinksResponse
Lists sinks. (sinks.listBillingAccountsSinks)
patch()  : Google_Service_Logging_LogSink
Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
update()  : Google_Service_Logging_LogSink
Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. (sinks.create)

public create(string $parent, Google_Service_Logging_LogSink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogSink
Parameters
$parent : string

Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789".

$postBody : Google_Service_Logging_LogSink
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.

Return values
Google_Service_Logging_LogSink —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. (sinks.delete)

public delete(string $sinkName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LoggingEmpty
Parameters
$sinkName : string

Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks /my-sink-id".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Logging_LoggingEmpty —

get()

Gets a sink. (sinks.get)

public get(string $sinkName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogSink
Parameters
$sinkName : string

Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks /my-sink-id".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Logging_LogSink —

listBillingAccountsSinks()

Lists sinks. (sinks.listBillingAccountsSinks)

public listBillingAccountsSinks(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_ListSinksResponse
Parameters
$parent : string

Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

opt_param

string pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Return values
Google_Service_Logging_ListSinksResponse —

patch()

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.

public patch(string $sinkName, Google_Service_Logging_LogSink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogSink

(sinks.patch)

Parameters
$sinkName : string

Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks /my-sink-id".

$postBody : Google_Service_Logging_LogSink
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.

opt_param

bool uniqueWriterIdentity Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false.

Return values
Google_Service_Logging_LogSink —

update()

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.

public update(string $sinkName, Google_Service_Logging_LogSink $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogSink

(sinks.update)

Parameters
$sinkName : string

Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks /my-sink-id".

$postBody : Google_Service_Logging_LogSink
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool uniqueWriterIdentity Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false.

opt_param

string updateMask Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.

Return values
Google_Service_Logging_LogSink —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results