Class: Google::Apis::LoggingV2::WriteLogEntriesRequest
- Inherits:
-
Object
- Object
- Google::Apis::LoggingV2::WriteLogEntriesRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/logging_v2/classes.rb,
generated/google/apis/logging_v2/representations.rb,
generated/google/apis/logging_v2/representations.rb
Overview
The parameters to WriteLogEntries.
Instance Attribute Summary collapse
-
#dry_run ⇒ Boolean
(also: #dry_run?)
Optional.
-
#entries ⇒ Array<Google::Apis::LoggingV2::LogEntry>
Required.
-
#labels ⇒ Hash<String,String>
Optional.
-
#log_name ⇒ String
Optional.
-
#partial_success ⇒ Boolean
(also: #partial_success?)
Optional.
-
#resource ⇒ Google::Apis::LoggingV2::MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes.
Instance Method Summary collapse
-
#initialize(**args) ⇒ WriteLogEntriesRequest
constructor
A new instance of WriteLogEntriesRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ WriteLogEntriesRequest
Returns a new instance of WriteLogEntriesRequest
1855 1856 1857 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1855 def initialize(**args) update!(**args) end |
Instance Attribute Details
#dry_run ⇒ Boolean Also known as: dry_run?
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.
Corresponds to the JSON property dryRun
1783 1784 1785 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1783 def dry_run @dry_run end |
#entries ⇒ Array<Google::Apis::LoggingV2::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 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.
Corresponds to the JSON property entries
1803 1804 1805 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1803 def entries @entries end |
#labels ⇒ Hash<String,String>
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.
Corresponds to the JSON property labels
1810 1811 1812 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1810 def labels @labels end |
#log_name ⇒ String
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/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
The permission logging.logEntries.create
is needed on each
project, organization, billing account, or folder that is receiving new log
entries, whether the resource is specified in logName
or in an
individual log entry.
Corresponds to the JSON property logName
1827 1828 1829 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1827 def log_name @log_name end |
#partial_success ⇒ Boolean Also known as: partial_success?
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.
Corresponds to the JSON property partialSuccess
1836 1837 1838 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1836 def partial_success @partial_success end |
#resource ⇒ Google::Apis::LoggingV2::MonitoredResource
An object representing a resource that can be used for monitoring, logging,
billing, or other purposes. Examples include virtual machine instances,
databases, and storage devices such as disks. The type field identifies a
MonitoredResourceDescriptor object that describes the resource's schema.
Information in the labels field identifies the actual resource and its
attributes according to the schema. For example, a particular Compute Engine
VM instance could be represented by the following object, because the
MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "
zone":
"type": "gce_instance",
"labels":
"instance_id": "12345678901234",
"zone": "us-central1-a" `
Corresponds to the JSON property
resource`
1853 1854 1855 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1853 def resource @resource end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1860 1861 1862 1863 1864 1865 1866 1867 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1860 def update!(**args) @dry_run = args[:dry_run] if args.key?(:dry_run) @entries = args[:entries] if args.key?(:entries) @labels = args[:labels] if args.key?(:labels) @log_name = args[:log_name] if args.key?(:log_name) @partial_success = args[:partial_success] if args.key?(:partial_success) @resource = args[:resource] if args.key?(:resource) end |