Reference documentation and code samples for the Stackdriver Logging V2 Client class WriteLogEntriesRequest.
The parameters to WriteLogEntries.
Generated from protobuf message google.logging.v2.WriteLogEntriesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ log_name |
string
Optional. A default log resource name that is assigned to all log entries in |
↳ resource |
Google\Api\MonitoredResource
Optional. A default monitored resource object that is assigned to all log entries in |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Default labels that are added to the |
↳ entries |
array<Google\Cloud\Logging\V2\LogEntry>
Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's |
↳ partial_success |
bool
Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the |
↳ dry_run |
bool
Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data. |
getLogName
Optional. A default log resource name that is assigned to all log entries
in entries that do not specify a value for log_name:
projects/[PROJECT_ID]/logs/[LOG_ID]organizations/[ORGANIZATION_ID]/logs/[LOG_ID]billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID]must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity" The permissionlogging.logEntries.createis needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified inlogNameor in an individual log entry.
Generated from protobuf field string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setLogName
Optional. A default log resource name that is assigned to all log entries
in entries that do not specify a value for log_name:
projects/[PROJECT_ID]/logs/[LOG_ID]organizations/[ORGANIZATION_ID]/logs/[LOG_ID]billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID]must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity" The permissionlogging.logEntries.createis needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified inlogNameor in an individual log entry.
Generated from protobuf field string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResource
Optional. A default monitored resource object that is assigned to all log
entries in entries that do not specify a value for resource. Example:
{ "type": "gce_instance",
"labels": {
"zone": "us-central1-a", "instance_id": "00000000000000000000" }}
See LogEntry.
Generated from protobuf field .google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Api\MonitoredResource|null | |
hasResource
clearResource
setResource
Optional. A default monitored resource object that is assigned to all log
entries in entries that do not specify a value for resource. Example:
{ "type": "gce_instance",
"labels": {
"zone": "us-central1-a", "instance_id": "00000000000000000000" }}
See LogEntry.
Generated from protobuf field .google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\MonitoredResource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
Generated from protobuf field map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
Generated from protobuf field map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntries
Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
Generated from protobuf field repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEntries
Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
Generated from protobuf field repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Logging\V2\LogEntry>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartialSuccess
Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the entries.write method.
Generated from protobuf field bool partial_success = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setPartialSuccess
Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the entries.write method.
Generated from protobuf field bool partial_success = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDryRun
Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.
Generated from protobuf field bool dry_run = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setDryRun
Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.
Generated from protobuf field bool dry_run = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |