Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- logging.entries.list
- logging.entries.write
- logging.monitoredResourceDescriptors.list
- logging.projects.logs.delete
- logging.projects.metrics.create
- logging.projects.metrics.delete
- logging.projects.metrics.get
- logging.projects.metrics.list
- logging.projects.metrics.update
- logging.projects.sinks.create
- logging.projects.sinks.delete
- logging.projects.sinks.get
- logging.projects.sinks.list
- logging.projects.sinks.update
- Types
- MonitoredResourceDescriptor
- Status
- ListLogEntriesResponse
- MonitoredResourceLabels
- ListLogMetricsResponse
- WriteLogEntriesRequest
- Empty
- LogEntryLabels
- ListSinksResponse
- RequestLog
- LogEntryProtoPayload
- WriteLogEntriesResponse
- LogSink
- StatusDetailsItem
- ListMonitoredResourceDescriptorsResponse
- HTTPRequest
- ListLogEntriesResponseProjectIdErrors
- WriteLogEntriesRequestLabels
- MonitoredResource
- LogLine
- LabelDescriptor
- ListLogEntriesRequest
- LogEntryOperation
- LogMetric
- LogEntry
- SourceLocation
- SourceReference
- LogEntryJSONPayload
Writes log entries and manages your logs, log sinks, and logs-based metrics.
- loggingService :: ServiceConfig
- loggingAdminScope :: Proxy '["https://www.googleapis.com/auth/logging.admin"]
- loggingReadScope :: Proxy '["https://www.googleapis.com/auth/logging.read"]
- loggingWriteScope :: Proxy '["https://www.googleapis.com/auth/logging.write"]
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type LoggingAPI = EntriesListResource :<|> (EntriesWriteResource :<|> (MonitoredResourceDescriptorsListResource :<|> (ProjectsSinksListResource :<|> (ProjectsSinksGetResource :<|> (ProjectsSinksCreateResource :<|> (ProjectsSinksDeleteResource :<|> (ProjectsSinksUpdateResource :<|> (ProjectsMetricsListResource :<|> (ProjectsMetricsGetResource :<|> (ProjectsMetricsCreateResource :<|> (ProjectsMetricsDeleteResource :<|> (ProjectsMetricsUpdateResource :<|> ProjectsLogsDeleteResource))))))))))))
- module Network.Google.Resource.Logging.Entries.List
- module Network.Google.Resource.Logging.Entries.Write
- module Network.Google.Resource.Logging.MonitoredResourceDescriptors.List
- module Network.Google.Resource.Logging.Projects.Logs.Delete
- module Network.Google.Resource.Logging.Projects.Metrics.Create
- module Network.Google.Resource.Logging.Projects.Metrics.Delete
- module Network.Google.Resource.Logging.Projects.Metrics.Get
- module Network.Google.Resource.Logging.Projects.Metrics.List
- module Network.Google.Resource.Logging.Projects.Metrics.Update
- module Network.Google.Resource.Logging.Projects.Sinks.Create
- module Network.Google.Resource.Logging.Projects.Sinks.Delete
- module Network.Google.Resource.Logging.Projects.Sinks.Get
- module Network.Google.Resource.Logging.Projects.Sinks.List
- module Network.Google.Resource.Logging.Projects.Sinks.Update
- data MonitoredResourceDescriptor
- monitoredResourceDescriptor :: MonitoredResourceDescriptor
- mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor]
- mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data ListLogEntriesResponse
- listLogEntriesResponse :: ListLogEntriesResponse
- llerNextPageToken :: Lens' ListLogEntriesResponse (Maybe Text)
- llerEntries :: Lens' ListLogEntriesResponse [LogEntry]
- llerProjectIdErrors :: Lens' ListLogEntriesResponse (Maybe ListLogEntriesResponseProjectIdErrors)
- data MonitoredResourceLabels
- monitoredResourceLabels :: HashMap Text Text -> MonitoredResourceLabels
- mrlAddtional :: Lens' MonitoredResourceLabels (HashMap Text Text)
- data ListLogMetricsResponse
- listLogMetricsResponse :: ListLogMetricsResponse
- llmrMetrics :: Lens' ListLogMetricsResponse [LogMetric]
- llmrNextPageToken :: Lens' ListLogMetricsResponse (Maybe Text)
- data WriteLogEntriesRequest
- writeLogEntriesRequest :: WriteLogEntriesRequest
- wlerEntries :: Lens' WriteLogEntriesRequest [LogEntry]
- wlerPartialSuccess :: Lens' WriteLogEntriesRequest (Maybe Bool)
- wlerResource :: Lens' WriteLogEntriesRequest (Maybe MonitoredResource)
- wlerLabels :: Lens' WriteLogEntriesRequest (Maybe WriteLogEntriesRequestLabels)
- wlerLogName :: Lens' WriteLogEntriesRequest (Maybe Text)
- data Empty
- empty :: Empty
- data LogEntryLabels
- logEntryLabels :: HashMap Text Text -> LogEntryLabels
- lelAddtional :: Lens' LogEntryLabels (HashMap Text Text)
- data ListSinksResponse
- listSinksResponse :: ListSinksResponse
- lsrSinks :: Lens' ListSinksResponse [LogSink]
- lsrNextPageToken :: Lens' ListSinksResponse (Maybe Text)
- data RequestLog
- requestLog :: RequestLog
- rlTraceId :: Lens' RequestLog (Maybe Text)
- rlInstanceId :: Lens' RequestLog (Maybe Text)
- rlStatus :: Lens' RequestLog (Maybe Int32)
- rlRequestId :: Lens' RequestLog (Maybe Text)
- rlInstanceIndex :: Lens' RequestLog (Maybe Int32)
- rlModuleId :: Lens' RequestLog (Maybe Text)
- rlVersionId :: Lens' RequestLog (Maybe Text)
- rlHTTPVersion :: Lens' RequestLog (Maybe Text)
- rlTaskName :: Lens' RequestLog (Maybe Text)
- rlPendingTime :: Lens' RequestLog (Maybe Text)
- rlWasLoadingRequest :: Lens' RequestLog (Maybe Bool)
- rlFirst :: Lens' RequestLog (Maybe Bool)
- rlStartTime :: Lens' RequestLog (Maybe Text)
- rlLatency :: Lens' RequestLog (Maybe Text)
- rlURLMapEntry :: Lens' RequestLog (Maybe Text)
- rlCost :: Lens' RequestLog (Maybe Double)
- rlReferrer :: Lens' RequestLog (Maybe Text)
- rlLine :: Lens' RequestLog [LogLine]
- rlIP :: Lens' RequestLog (Maybe Text)
- rlAppId :: Lens' RequestLog (Maybe Text)
- rlMethod :: Lens' RequestLog (Maybe Text)
- rlResource :: Lens' RequestLog (Maybe Text)
- rlEndTime :: Lens' RequestLog (Maybe Text)
- rlFinished :: Lens' RequestLog (Maybe Bool)
- rlMegaCycles :: Lens' RequestLog (Maybe Int64)
- rlUserAgent :: Lens' RequestLog (Maybe Text)
- rlNickname :: Lens' RequestLog (Maybe Text)
- rlHost :: Lens' RequestLog (Maybe Text)
- rlTaskQueueName :: Lens' RequestLog (Maybe Text)
- rlResponseSize :: Lens' RequestLog (Maybe Int64)
- rlSourceReference :: Lens' RequestLog [SourceReference]
- rlAppEngineRelease :: Lens' RequestLog (Maybe Text)
- data LogEntryProtoPayload
- logEntryProtoPayload :: HashMap Text JSONValue -> LogEntryProtoPayload
- leppAddtional :: Lens' LogEntryProtoPayload (HashMap Text JSONValue)
- data WriteLogEntriesResponse
- writeLogEntriesResponse :: WriteLogEntriesResponse
- data LogSink
- logSink :: LogSink
- lsDestination :: Lens' LogSink (Maybe Text)
- lsOutputVersionFormat :: Lens' LogSink (Maybe Text)
- lsName :: Lens' LogSink (Maybe Text)
- lsFilter :: Lens' LogSink (Maybe Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data ListMonitoredResourceDescriptorsResponse
- listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse
- lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text)
- lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor]
- data HTTPRequest
- hTTPRequest :: HTTPRequest
- httprStatus :: Lens' HTTPRequest (Maybe Int32)
- httprRequestURL :: Lens' HTTPRequest (Maybe Text)
- httprCacheFillBytes :: Lens' HTTPRequest (Maybe Int64)
- httprRemoteIP :: Lens' HTTPRequest (Maybe Text)
- httprRequestSize :: Lens' HTTPRequest (Maybe Int64)
- httprCacheValidatedWithOriginServer :: Lens' HTTPRequest (Maybe Bool)
- httprUserAgent :: Lens' HTTPRequest (Maybe Text)
- httprCacheLookup :: Lens' HTTPRequest (Maybe Bool)
- httprResponseSize :: Lens' HTTPRequest (Maybe Int64)
- httprRequestMethod :: Lens' HTTPRequest (Maybe Text)
- httprCacheHit :: Lens' HTTPRequest (Maybe Bool)
- httprReferer :: Lens' HTTPRequest (Maybe Text)
- data ListLogEntriesResponseProjectIdErrors
- listLogEntriesResponseProjectIdErrors :: HashMap Text Status -> ListLogEntriesResponseProjectIdErrors
- llerpieAddtional :: Lens' ListLogEntriesResponseProjectIdErrors (HashMap Text Status)
- data WriteLogEntriesRequestLabels
- writeLogEntriesRequestLabels :: HashMap Text Text -> WriteLogEntriesRequestLabels
- wlerlAddtional :: Lens' WriteLogEntriesRequestLabels (HashMap Text Text)
- data MonitoredResource
- monitoredResource :: MonitoredResource
- mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels)
- mrType :: Lens' MonitoredResource (Maybe Text)
- data LogLine
- logLine :: LogLine
- llTime :: Lens' LogLine (Maybe Text)
- llSeverity :: Lens' LogLine (Maybe Text)
- llLogMessage :: Lens' LogLine (Maybe Text)
- llSourceLocation :: Lens' LogLine (Maybe SourceLocation)
- data LabelDescriptor
- labelDescriptor :: LabelDescriptor
- ldKey :: Lens' LabelDescriptor (Maybe Text)
- ldValueType :: Lens' LabelDescriptor (Maybe Text)
- ldDescription :: Lens' LabelDescriptor (Maybe Text)
- data ListLogEntriesRequest
- listLogEntriesRequest :: ListLogEntriesRequest
- llerOrderBy :: Lens' ListLogEntriesRequest (Maybe Text)
- llerPartialSuccess :: Lens' ListLogEntriesRequest (Maybe Bool)
- llerProjectIds :: Lens' ListLogEntriesRequest [Text]
- llerFilter :: Lens' ListLogEntriesRequest (Maybe Text)
- llerPageToken :: Lens' ListLogEntriesRequest (Maybe Text)
- llerPageSize :: Lens' ListLogEntriesRequest (Maybe Int32)
- data LogEntryOperation
- logEntryOperation :: LogEntryOperation
- leoFirst :: Lens' LogEntryOperation (Maybe Bool)
- leoProducer :: Lens' LogEntryOperation (Maybe Text)
- leoLast :: Lens' LogEntryOperation (Maybe Bool)
- leoId :: Lens' LogEntryOperation (Maybe Text)
- data LogMetric
- logMetric :: LogMetric
- lmName :: Lens' LogMetric (Maybe Text)
- lmFilter :: Lens' LogMetric (Maybe Text)
- lmDescription :: Lens' LogMetric (Maybe Text)
- data LogEntry
- logEntry :: LogEntry
- leOperation :: Lens' LogEntry (Maybe LogEntryOperation)
- leSeverity :: Lens' LogEntry (Maybe Text)
- leTextPayload :: Lens' LogEntry (Maybe Text)
- leJSONPayload :: Lens' LogEntry (Maybe LogEntryJSONPayload)
- leHTTPRequest :: Lens' LogEntry (Maybe HTTPRequest)
- leResource :: Lens' LogEntry (Maybe MonitoredResource)
- leInsertId :: Lens' LogEntry (Maybe Text)
- leLabels :: Lens' LogEntry (Maybe LogEntryLabels)
- leProtoPayload :: Lens' LogEntry (Maybe LogEntryProtoPayload)
- leLogName :: Lens' LogEntry (Maybe Text)
- leTimestamp :: Lens' LogEntry (Maybe Text)
- data SourceLocation
- sourceLocation :: SourceLocation
- slLine :: Lens' SourceLocation (Maybe Int64)
- slFunctionName :: Lens' SourceLocation (Maybe Text)
- slFile :: Lens' SourceLocation (Maybe Text)
- data SourceReference
- sourceReference :: SourceReference
- srRepository :: Lens' SourceReference (Maybe Text)
- srRevisionId :: Lens' SourceReference (Maybe Text)
- data LogEntryJSONPayload
- logEntryJSONPayload :: HashMap Text JSONValue -> LogEntryJSONPayload
- lejpAddtional :: Lens' LogEntryJSONPayload (HashMap Text JSONValue)
Service Configuration
loggingService :: ServiceConfig Source #
Default request referring to version v2beta1
of the Google Cloud Logging API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
loggingAdminScope :: Proxy '["https://www.googleapis.com/auth/logging.admin"] Source #
Administrate log data for your projects
loggingReadScope :: Proxy '["https://www.googleapis.com/auth/logging.read"] Source #
View log data for your projects
loggingWriteScope :: Proxy '["https://www.googleapis.com/auth/logging.write"] Source #
Submit log data for your projects
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type LoggingAPI = EntriesListResource :<|> (EntriesWriteResource :<|> (MonitoredResourceDescriptorsListResource :<|> (ProjectsSinksListResource :<|> (ProjectsSinksGetResource :<|> (ProjectsSinksCreateResource :<|> (ProjectsSinksDeleteResource :<|> (ProjectsSinksUpdateResource :<|> (ProjectsMetricsListResource :<|> (ProjectsMetricsGetResource :<|> (ProjectsMetricsCreateResource :<|> (ProjectsMetricsDeleteResource :<|> (ProjectsMetricsUpdateResource :<|> ProjectsLogsDeleteResource)))))))))))) Source #
Represents the entirety of the methods and resources available for the Google Cloud Logging API service.
Resources
logging.entries.list
logging.entries.write
logging.monitoredResourceDescriptors.list
logging.projects.logs.delete
logging.projects.metrics.create
logging.projects.metrics.delete
logging.projects.metrics.get
logging.projects.metrics.list
logging.projects.metrics.update
logging.projects.sinks.create
logging.projects.sinks.delete
logging.projects.sinks.get
logging.projects.sinks.list
logging.projects.sinks.update
Types
MonitoredResourceDescriptor
data MonitoredResourceDescriptor Source #
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
See: monitoredResourceDescriptor
smart constructor.
monitoredResourceDescriptor :: MonitoredResourceDescriptor Source #
Creates a value of MonitoredResourceDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.
mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor] Source #
Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.
mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL.
mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. A detailed description of the monitored resource type that might be used in documentation.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There will be a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
ListLogEntriesResponse
data ListLogEntriesResponse Source #
Result returned from `ListLogEntries`.
See: listLogEntriesResponse
smart constructor.
listLogEntriesResponse :: ListLogEntriesResponse Source #
Creates a value of ListLogEntriesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llerNextPageToken :: Lens' ListLogEntriesResponse (Maybe Text) Source #
If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
llerEntries :: Lens' ListLogEntriesResponse [LogEntry] Source #
A list of log entries.
llerProjectIdErrors :: Lens' ListLogEntriesResponse (Maybe ListLogEntriesResponseProjectIdErrors) Source #
If partial_success is true, contains the project ids that had errors and the associated errors.
MonitoredResourceLabels
data MonitoredResourceLabels Source #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
See: monitoredResourceLabels
smart constructor.
monitoredResourceLabels Source #
Creates a value of MonitoredResourceLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListLogMetricsResponse
data ListLogMetricsResponse Source #
Result returned from ListLogMetrics.
See: listLogMetricsResponse
smart constructor.
listLogMetricsResponse :: ListLogMetricsResponse Source #
Creates a value of ListLogMetricsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llmrMetrics :: Lens' ListLogMetricsResponse [LogMetric] Source #
A list of logs-based metrics.
llmrNextPageToken :: Lens' ListLogMetricsResponse (Maybe Text) Source #
If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
WriteLogEntriesRequest
data WriteLogEntriesRequest Source #
The parameters to WriteLogEntries.
See: writeLogEntriesRequest
smart constructor.
writeLogEntriesRequest :: WriteLogEntriesRequest Source #
Creates a value of WriteLogEntriesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wlerEntries :: Lens' WriteLogEntriesRequest [LogEntry] Source #
Required. The log entries to write. The log entries must have values for all required fields.
wlerPartialSuccess :: Lens' WriteLogEntriesRequest (Maybe Bool) Source #
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, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.
wlerResource :: Lens' WriteLogEntriesRequest (Maybe MonitoredResource) Source #
Optional. A default monitored resource for those log entries in `entries` that do not specify their own `resource`.
wlerLabels :: Lens' WriteLogEntriesRequest (Maybe WriteLogEntriesRequestLabels) Source #
Optional. User-defined `key:value` items that are added to the `labels` field of each log entry in `entries`, except when a log entry specifies its own `key:value` item with the same key. Example: `{ "size": "large", "color":"red" }`
wlerLogName :: Lens' WriteLogEntriesRequest (Maybe Text) Source #
Optional. A default log resource name for those log entries in `entries` that do not specify their own `logName`. Example: `"projects/my-project/logs/syslog"`. See LogEntry.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
LogEntryLabels
data LogEntryLabels Source #
Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
See: logEntryLabels
smart constructor.
Creates a value of LogEntryLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListSinksResponse
data ListSinksResponse Source #
Result returned from `ListSinks`.
See: listSinksResponse
smart constructor.
listSinksResponse :: ListSinksResponse Source #
Creates a value of ListSinksResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrNextPageToken :: Lens' ListSinksResponse (Maybe Text) Source #
If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
RequestLog
data RequestLog Source #
Complete log information about a single HTTP request to an App Engine application.
See: requestLog
smart constructor.
requestLog :: RequestLog Source #
Creates a value of RequestLog
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rlTraceId
rlInstanceId
rlStatus
rlRequestId
rlInstanceIndex
rlModuleId
rlVersionId
rlHTTPVersion
rlTaskName
rlPendingTime
rlWasLoadingRequest
rlFirst
rlStartTime
rlLatency
rlURLMapEntry
rlCost
rlReferrer
rlLine
rlIP
rlAppId
rlMethod
rlResource
rlEndTime
rlFinished
rlMegaCycles
rlUserAgent
rlNickname
rlHost
rlTaskQueueName
rlResponseSize
rlSourceReference
rlAppEngineRelease
rlInstanceId :: Lens' RequestLog (Maybe Text) Source #
An identifier for the instance that handled the request.
rlRequestId :: Lens' RequestLog (Maybe Text) Source #
Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.
rlInstanceIndex :: Lens' RequestLog (Maybe Int32) Source #
If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.
rlModuleId :: Lens' RequestLog (Maybe Text) Source #
Module of the application that handled this request.
rlVersionId :: Lens' RequestLog (Maybe Text) Source #
Version of the application that handled this request.
rlHTTPVersion :: Lens' RequestLog (Maybe Text) Source #
HTTP version of request. Example: `"HTTP/1.1"`.
rlTaskName :: Lens' RequestLog (Maybe Text) Source #
Task name of the request, in the case of an offline request.
rlPendingTime :: Lens' RequestLog (Maybe Text) Source #
Time this request spent in the pending request queue.
rlWasLoadingRequest :: Lens' RequestLog (Maybe Bool) Source #
Whether this was a loading request for the instance.
rlFirst :: Lens' RequestLog (Maybe Bool) Source #
Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Cloud Logging, this field will be set for one of them.
rlStartTime :: Lens' RequestLog (Maybe Text) Source #
Time when the request started.
rlURLMapEntry :: Lens' RequestLog (Maybe Text) Source #
File or class that handled the request.
rlCost :: Lens' RequestLog (Maybe Double) Source #
An indication of the relative cost of serving this request.
rlReferrer :: Lens' RequestLog (Maybe Text) Source #
Referrer URL of request.
rlLine :: Lens' RequestLog [LogLine] Source #
A list of log lines emitted by the application while serving this request.
rlMethod :: Lens' RequestLog (Maybe Text) Source #
Request method. Example: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`, `"DELETE"`.
rlResource :: Lens' RequestLog (Maybe Text) Source #
Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the `#` character, is not included.
rlFinished :: Lens' RequestLog (Maybe Bool) Source #
Whether this request is finished or active.
rlMegaCycles :: Lens' RequestLog (Maybe Int64) Source #
Number of CPU megacycles used to process request.
rlUserAgent :: Lens' RequestLog (Maybe Text) Source #
User agent that made the request.
rlNickname :: Lens' RequestLog (Maybe Text) Source #
The logged-in user who made the request. Most likely, this is the part of the user's email before the `'` sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API. This field will be populated starting with App Engine 1.9.21.
rlHost :: Lens' RequestLog (Maybe Text) Source #
Internet host and port number of the resource being requested.
rlTaskQueueName :: Lens' RequestLog (Maybe Text) Source #
Queue name of the request, in the case of an offline request.
rlResponseSize :: Lens' RequestLog (Maybe Int64) Source #
Size in bytes sent back to client by request.
rlSourceReference :: Lens' RequestLog [SourceReference] Source #
Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.
rlAppEngineRelease :: Lens' RequestLog (Maybe Text) Source #
App Engine release version.
LogEntryProtoPayload
data LogEntryProtoPayload Source #
The log entry payload, represented as a protocol buffer. You can only use `protoPayload` values that belong to a set of approved types.
See: logEntryProtoPayload
smart constructor.
Creates a value of LogEntryProtoPayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leppAddtional :: Lens' LogEntryProtoPayload (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
WriteLogEntriesResponse
data WriteLogEntriesResponse Source #
Result returned from WriteLogEntries. empty
See: writeLogEntriesResponse
smart constructor.
writeLogEntriesResponse :: WriteLogEntriesResponse Source #
Creates a value of WriteLogEntriesResponse
with the minimum fields required to make a request.
LogSink
Describes a sink used to export log entries outside Cloud Logging.
See: logSink
smart constructor.
Creates a value of LogSink
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsDestination :: Lens' LogSink (Maybe Text) Source #
The export destination. See Exporting Logs With Sinks. Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
lsOutputVersionFormat :: Lens' LogSink (Maybe Text) Source #
The log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
lsName :: Lens' LogSink (Maybe Text) Source #
Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
lsFilter :: Lens' LogSink (Maybe Text) Source #
An advanced logs filter. Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): `"logName=projects/my-projectid/logs/syslog AND severity>=ERROR"`.
StatusDetailsItem
data StatusDetailsItem Source #
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
ListMonitoredResourceDescriptorsResponse
data ListMonitoredResourceDescriptorsResponse Source #
Result returned from ListMonitoredResourceDescriptors.
See: listMonitoredResourceDescriptorsResponse
smart constructor.
listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse Source #
Creates a value of ListMonitoredResourceDescriptorsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text) Source #
If there are more results than were returned, then `nextPageToken` is included in the response. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`.
lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor] Source #
A list of resource descriptors.
HTTPRequest
data HTTPRequest Source #
A common proto for logging HTTP requests.
See: hTTPRequest
smart constructor.
hTTPRequest :: HTTPRequest Source #
Creates a value of HTTPRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httprStatus :: Lens' HTTPRequest (Maybe Int32) Source #
The response code indicating the status of response. Examples: 200, 404.
httprRequestURL :: Lens' HTTPRequest (Maybe Text) Source #
The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`.
httprCacheFillBytes :: Lens' HTTPRequest (Maybe Int64) Source #
The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
httprRemoteIP :: Lens' HTTPRequest (Maybe Text) Source #
The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
httprRequestSize :: Lens' HTTPRequest (Maybe Int64) Source #
The size of the HTTP request message in bytes, including the request headers and the request body.
httprCacheValidatedWithOriginServer :: Lens' HTTPRequest (Maybe Bool) Source #
Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.
httprUserAgent :: Lens' HTTPRequest (Maybe Text) Source #
The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
httprCacheLookup :: Lens' HTTPRequest (Maybe Bool) Source #
Whether or not a cache lookup was attempted.
httprResponseSize :: Lens' HTTPRequest (Maybe Int64) Source #
The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
httprRequestMethod :: Lens' HTTPRequest (Maybe Text) Source #
The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
httprCacheHit :: Lens' HTTPRequest (Maybe Bool) Source #
Whether or not an entity was served from cache (with or without validation).
httprReferer :: Lens' HTTPRequest (Maybe Text) Source #
The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
ListLogEntriesResponseProjectIdErrors
data ListLogEntriesResponseProjectIdErrors Source #
If partial_success is true, contains the project ids that had errors and the associated errors.
See: listLogEntriesResponseProjectIdErrors
smart constructor.
listLogEntriesResponseProjectIdErrors Source #
Creates a value of ListLogEntriesResponseProjectIdErrors
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
WriteLogEntriesRequestLabels
data WriteLogEntriesRequestLabels Source #
Optional. User-defined `key:value` items that are added to the `labels` field of each log entry in `entries`, except when a log entry specifies its own `key:value` item with the same key. Example: `{ "size": "large", "color":"red" }`
See: writeLogEntriesRequestLabels
smart constructor.
writeLogEntriesRequestLabels Source #
Creates a value of WriteLogEntriesRequestLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MonitoredResource
data MonitoredResource Source #
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": "my-instance", "zone": "us-central1-a" }}
See: monitoredResource
smart constructor.
monitoredResource :: MonitoredResource Source #
Creates a value of MonitoredResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels) Source #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels `"database_id"` and `"zone"`.
mrType :: Lens' MonitoredResource (Maybe Text) Source #
Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is `"cloudsql_database"`.
LogLine
Application log line emitted while processing a request.
See: logLine
smart constructor.
Creates a value of LogLine
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llSourceLocation :: Lens' LogLine (Maybe SourceLocation) Source #
Where in the source code this log message was written.
LabelDescriptor
data LabelDescriptor Source #
A description of a label.
See: labelDescriptor
smart constructor.
labelDescriptor :: LabelDescriptor Source #
Creates a value of LabelDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldValueType :: Lens' LabelDescriptor (Maybe Text) Source #
The type of data that can be assigned to the label.
ldDescription :: Lens' LabelDescriptor (Maybe Text) Source #
A human-readable description for the label.
ListLogEntriesRequest
data ListLogEntriesRequest Source #
The parameters to `ListLogEntries`.
See: listLogEntriesRequest
smart constructor.
listLogEntriesRequest :: ListLogEntriesRequest Source #
Creates a value of ListLogEntriesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llerOrderBy :: Lens' ListLogEntriesRequest (Maybe Text) Source #
Optional. How the results should be sorted. Presently, the only permitted values are `"timestamp asc"` (default) and `"timestamp desc"`. The first option returns entries in order of increasing values of `LogEntry.timestamp` (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of `LogEntry.insertId`.
llerPartialSuccess :: Lens' ListLogEntriesRequest (Maybe Bool) Source #
Optional. If true, read access to all projects is not required and results will be returned for the subset of projects for which read access is permitted (empty subset is permitted).
llerProjectIds :: Lens' ListLogEntriesRequest [Text] Source #
Required. One or more project IDs or project numbers from which to retrieve log entries. Examples of a project ID: `"my-project-1A"`, `"1234567890"`.
llerFilter :: Lens' ListLogEntriesRequest (Maybe Text) Source #
Optional. An advanced logs filter. The filter is compared against all log entries in the projects specified by `projectIds`. Only entries that match the filter are retrieved. An empty filter matches all log entries.
llerPageToken :: Lens' ListLogEntriesRequest (Maybe Text) Source #
Optional. If the `pageToken` parameter is supplied, then the next page of results is retrieved. The `pageToken` parameter must be set to the value of the `nextPageToken` from the previous response. The values of `projectIds`, `filter`, and `orderBy` must be the same as in the previous request.
llerPageSize :: Lens' ListLogEntriesRequest (Maybe Int32) Source #
Optional. The maximum number of results to return from this request. You must check for presence of `nextPageToken` to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value as the `pageToken` parameter in the next request.
LogEntryOperation
data LogEntryOperation Source #
Additional information about a potentially long-running operation with which a log entry is associated.
See: logEntryOperation
smart constructor.
logEntryOperation :: LogEntryOperation Source #
Creates a value of LogEntryOperation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leoFirst :: Lens' LogEntryOperation (Maybe Bool) Source #
Optional. Set this to True if this is the first log entry in the operation.
leoProducer :: Lens' LogEntryOperation (Maybe Text) Source #
Required. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, "github.com/MyProject/MyApplication"`.
leoLast :: Lens' LogEntryOperation (Maybe Bool) Source #
Optional. Set this to True if this is the last log entry in the operation.
leoId :: Lens' LogEntryOperation (Maybe Text) Source #
Required. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
LogMetric
Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
See: logMetric
smart constructor.
logMetric :: LogMetric Source #
Creates a value of LogMetric
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmName :: Lens' LogMetric (Maybe Text) Source #
Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
lmFilter :: Lens' LogMetric (Maybe Text) Source #
An advanced logs filter. Example: `"logName:syslog AND severity>=ERROR"`.
lmDescription :: Lens' LogMetric (Maybe Text) Source #
A description of this metric, which is used in documentation.
LogEntry
An individual entry in a log.
See: logEntry
smart constructor.
Creates a value of LogEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leOperation :: Lens' LogEntry (Maybe LogEntryOperation) Source #
Optional. Information about an operation associated with the log entry, if applicable.
leSeverity :: Lens' LogEntry (Maybe Text) Source #
Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
leTextPayload :: Lens' LogEntry (Maybe Text) Source #
The log entry payload, represented as a Unicode string (UTF-8).
leJSONPayload :: Lens' LogEntry (Maybe LogEntryJSONPayload) Source #
The log entry payload, represented as a structure that is expressed as a JSON object.
leHTTPRequest :: Lens' LogEntry (Maybe HTTPRequest) Source #
Optional. Information about the HTTP request associated with this log entry, if applicable.
leResource :: Lens' LogEntry (Maybe MonitoredResource) Source #
Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
leInsertId :: Lens' LogEntry (Maybe Text) Source #
Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
leLabels :: Lens' LogEntry (Maybe LogEntryLabels) Source #
Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
leProtoPayload :: Lens' LogEntry (Maybe LogEntryProtoPayload) Source #
The log entry payload, represented as a protocol buffer. You can only use `protoPayload` values that belong to a set of approved types.
leLogName :: Lens' LogEntry (Maybe Text) Source #
Required. The resource name of the log to which this log entry belongs. The format of the name is `"projects/ /logs/"`. Examples: `"projects/my-projectid/logs/syslog"`, `"projects/1234567890/logs/library.googleapis.com%2Fbook_log"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded.
leTimestamp :: Lens' LogEntry (Maybe Text) Source #
Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
SourceLocation
data SourceLocation Source #
Specifies a location in a source code file.
See: sourceLocation
smart constructor.
sourceLocation :: SourceLocation Source #
Creates a value of SourceLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slFunctionName :: Lens' SourceLocation (Maybe Text) Source #
Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).
slFile :: Lens' SourceLocation (Maybe Text) Source #
Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
SourceReference
data SourceReference Source #
A reference to a particular snapshot of the source tree used to build and deploy an application.
See: sourceReference
smart constructor.
sourceReference :: SourceReference Source #
Creates a value of SourceReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srRepository :: Lens' SourceReference (Maybe Text) Source #
Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
srRevisionId :: Lens' SourceReference (Maybe Text) Source #
The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
LogEntryJSONPayload
data LogEntryJSONPayload Source #
The log entry payload, represented as a structure that is expressed as a JSON object.
See: logEntryJSONPayload
smart constructor.
Creates a value of LogEntryJSONPayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lejpAddtional :: Lens' LogEntryJSONPayload (HashMap Text JSONValue) Source #
Properties of the object.