WriteLogEntriesRequest
class WriteLogEntriesRequest extends Message
The parameters to WriteLogEntries.
Protobuf type Google\Logging\V2\WriteLogEntriesRequest
Methods
No description
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" or
"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".
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" or
"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".
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][google.logging.v2.LogEntry].
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][google.logging.v2.LogEntry].
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.
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.
Required. The log entries to write. Values supplied for the fields
log_name, resource, and labels in this entries.write request are
inserted into those log entries in this list that do not provide their own
values.
Required. The log entries to write. Values supplied for the fields
log_name, resource, and labels in this entries.write request are
inserted into those log entries in this list that do not provide their own
values.
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.
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.
Details
at line 83
__construct()
at line 104
string
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" or
"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".
For more information about log names, see [LogEntry][google.logging.v2.LogEntry].
Generated from protobuf field string log_name = 1;
at line 125
setLogName(string $var)
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" or
"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".
For more information about log names, see [LogEntry][google.logging.v2.LogEntry].
Generated from protobuf field string log_name = 1;
at line 142
MonitoredResource
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][google.logging.v2.LogEntry].
Generated from protobuf field .google.api.MonitoredResource resource = 2;
at line 158
setResource(MonitoredResource $var)
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][google.logging.v2.LogEntry].
Generated from protobuf field .google.api.MonitoredResource resource = 2;
at line 173
RepeatedField
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][google.logging.v2.LogEntry].
Generated from protobuf field map<string, string> labels = 3;
at line 187
setLabels(array|RepeatedField $var)
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][google.logging.v2.LogEntry].
Generated from protobuf field map<string, string> labels = 3;
at line 211
RepeatedField
getEntries()
Required. The log entries to write. Values supplied for the fields
log_name, resource, and labels in this entries.write request are
inserted into those log entries in this list that do not provide their own
values.
Stackdriver Logging also creates and inserts values for timestamp and
insert_id if the entries do not provide them. The created insert_id for
the N'th entry in this list will be greater than earlier entries and less
than later entries. Otherwise, the order of log entries in this list does
not matter.
To improve throughput and to avoid exceeding the
quota limit for calls to entries.write,
you should write multiple log entries at once rather than
calling this method for each individual log entry.
Generated from protobuf field repeated .google.logging.v2.LogEntry entries = 4;
at line 234
setEntries(array|RepeatedField $var)
Required. The log entries to write. Values supplied for the fields
log_name, resource, and labels in this entries.write request are
inserted into those log entries in this list that do not provide their own
values.
Stackdriver Logging also creates and inserts values for timestamp and
insert_id if the entries do not provide them. The created insert_id for
the N'th entry in this list will be greater than earlier entries and less
than later entries. Otherwise, the order of log entries in this list does
not matter.
To improve throughput and to avoid exceeding the
quota limit for calls to entries.write,
you should write multiple log entries at once rather than
calling this method for each individual log entry.
Generated from protobuf field repeated .google.logging.v2.LogEntry entries = 4;
at line 250
bool
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;
at line 265
setPartialSuccess(bool $var)
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;