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
- AuditLogServiceData
- Status
- RequestMetadata
- ReportRequest
- CheckRequest
- MetricValueLabels
- Distribution
- ExponentialBuckets
- AuthorizationInfo
- Operation
- MetricValueSet
- LogEntryLabels
- LogEntryProtoPayload
- LinearBuckets
- CheckErrorCode
- StatusDetailsItem
- CheckError
- ReportError
- OperationImportance
- MetricValue
- Xgafv
- AuditLogResponse
- CheckResponse
- ReportResponse
- LogEntry
- AuditLogRequest
- OperationLabels
- LogEntrySeverity
- ExplicitBuckets
- AuthenticationInfo
- AuditLog
- LogEntryStructPayload
- serviceControlService :: ServiceConfig
- serviceControlScope :: Proxy '["https://www.googleapis.com/auth/servicecontrol"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data AuditLogServiceData
- auditLogServiceData :: HashMap Text JSONValue -> AuditLogServiceData
- alsdAddtional :: Lens' AuditLogServiceData (HashMap Text JSONValue)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data RequestMetadata
- requestMetadata :: RequestMetadata
- rmCallerSuppliedUserAgent :: Lens' RequestMetadata (Maybe Text)
- rmCallerIP :: Lens' RequestMetadata (Maybe Text)
- data ReportRequest
- reportRequest :: ReportRequest
- rrServiceConfigId :: Lens' ReportRequest (Maybe Text)
- rrOperations :: Lens' ReportRequest [Operation]
- data CheckRequest
- checkRequest :: CheckRequest
- crOperation :: Lens' CheckRequest (Maybe Operation)
- crServiceConfigId :: Lens' CheckRequest (Maybe Text)
- data MetricValueLabels
- metricValueLabels :: HashMap Text Text -> MetricValueLabels
- mvlAddtional :: Lens' MetricValueLabels (HashMap Text Text)
- data Distribution
- distribution :: Distribution
- dSumOfSquaredDeviation :: Lens' Distribution (Maybe Double)
- dMean :: Lens' Distribution (Maybe Double)
- dExponentialBuckets :: Lens' Distribution (Maybe ExponentialBuckets)
- dMaximum :: Lens' Distribution (Maybe Double)
- dLinearBuckets :: Lens' Distribution (Maybe LinearBuckets)
- dCount :: Lens' Distribution (Maybe Int64)
- dMinimum :: Lens' Distribution (Maybe Double)
- dBucketCounts :: Lens' Distribution [Int64]
- dExplicitBuckets :: Lens' Distribution (Maybe ExplicitBuckets)
- data ExponentialBuckets
- exponentialBuckets :: ExponentialBuckets
- ebGrowthFactor :: Lens' ExponentialBuckets (Maybe Double)
- ebScale :: Lens' ExponentialBuckets (Maybe Double)
- ebNumFiniteBuckets :: Lens' ExponentialBuckets (Maybe Int32)
- data AuthorizationInfo
- authorizationInfo :: AuthorizationInfo
- aiGranted :: Lens' AuthorizationInfo (Maybe Bool)
- aiResource :: Lens' AuthorizationInfo (Maybe Text)
- aiPermission :: Lens' AuthorizationInfo (Maybe Text)
- data Operation
- operation :: Operation
- oImportance :: Lens' Operation (Maybe OperationImportance)
- oStartTime :: Lens' Operation (Maybe UTCTime)
- oEndTime :: Lens' Operation (Maybe UTCTime)
- oOperationName :: Lens' Operation (Maybe Text)
- oLabels :: Lens' Operation (Maybe OperationLabels)
- oOperationId :: Lens' Operation (Maybe Text)
- oConsumerId :: Lens' Operation (Maybe Text)
- oMetricValueSets :: Lens' Operation [MetricValueSet]
- oLogEntries :: Lens' Operation [LogEntry]
- data MetricValueSet
- metricValueSet :: MetricValueSet
- mvsMetricName :: Lens' MetricValueSet (Maybe Text)
- mvsMetricValues :: Lens' MetricValueSet [MetricValue]
- data LogEntryLabels
- logEntryLabels :: HashMap Text Text -> LogEntryLabels
- lelAddtional :: Lens' LogEntryLabels (HashMap Text Text)
- data LogEntryProtoPayload
- logEntryProtoPayload :: HashMap Text JSONValue -> LogEntryProtoPayload
- leppAddtional :: Lens' LogEntryProtoPayload (HashMap Text JSONValue)
- data LinearBuckets
- linearBuckets :: LinearBuckets
- lbOffSet :: Lens' LinearBuckets (Maybe Double)
- lbWidth :: Lens' LinearBuckets (Maybe Double)
- lbNumFiniteBuckets :: Lens' LinearBuckets (Maybe Int32)
- data CheckErrorCode
- = ErrorCodeUnspecified
- | NotFound
- | PermissionDenied
- | ResourceExhausted
- | ServiceNotActivated
- | BillingDisabled
- | ProjectDeleted
- | ProjectInvalid
- | IPAddressBlocked
- | RefererBlocked
- | ClientAppBlocked
- | APITargetBlocked
- | APIKeyInvalid
- | APIKeyExpired
- | APIKeyNotFound
- | NamespaceLookupUnavailable
- | ServiceStatusUnavailable
- | BillingStatusUnavailable
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data CheckError
- checkError :: CheckError
- ceCode :: Lens' CheckError (Maybe CheckErrorCode)
- ceDetail :: Lens' CheckError (Maybe Text)
- data ReportError
- reportError :: ReportError
- reStatus :: Lens' ReportError (Maybe Status)
- reOperationId :: Lens' ReportError (Maybe Text)
- data OperationImportance
- data MetricValue
- metricValue :: MetricValue
- mvBoolValue :: Lens' MetricValue (Maybe Bool)
- mvStartTime :: Lens' MetricValue (Maybe UTCTime)
- mvDoubleValue :: Lens' MetricValue (Maybe Double)
- mvStringValue :: Lens' MetricValue (Maybe Text)
- mvDistributionValue :: Lens' MetricValue (Maybe Distribution)
- mvEndTime :: Lens' MetricValue (Maybe UTCTime)
- mvInt64Value :: Lens' MetricValue (Maybe Int64)
- mvLabels :: Lens' MetricValue (Maybe MetricValueLabels)
- data Xgafv
- data AuditLogResponse
- auditLogResponse :: HashMap Text JSONValue -> AuditLogResponse
- alrAddtional :: Lens' AuditLogResponse (HashMap Text JSONValue)
- data CheckResponse
- checkResponse :: CheckResponse
- cCheckErrors :: Lens' CheckResponse [CheckError]
- cServiceConfigId :: Lens' CheckResponse (Maybe Text)
- cOperationId :: Lens' CheckResponse (Maybe Text)
- data ReportResponse
- reportResponse :: ReportResponse
- rReportErrors :: Lens' ReportResponse [ReportError]
- rServiceConfigId :: Lens' ReportResponse (Maybe Text)
- data LogEntry
- logEntry :: LogEntry
- leSeverity :: Lens' LogEntry (Maybe LogEntrySeverity)
- leTextPayload :: Lens' LogEntry (Maybe Text)
- leStructPayload :: Lens' LogEntry (Maybe LogEntryStructPayload)
- leName :: Lens' LogEntry (Maybe Text)
- leInsertId :: Lens' LogEntry (Maybe Text)
- leLabels :: Lens' LogEntry (Maybe LogEntryLabels)
- leProtoPayload :: Lens' LogEntry (Maybe LogEntryProtoPayload)
- leTimestamp :: Lens' LogEntry (Maybe UTCTime)
- data AuditLogRequest
- auditLogRequest :: HashMap Text JSONValue -> AuditLogRequest
- aAddtional :: Lens' AuditLogRequest (HashMap Text JSONValue)
- data OperationLabels
- operationLabels :: HashMap Text Text -> OperationLabels
- olAddtional :: Lens' OperationLabels (HashMap Text Text)
- data LogEntrySeverity
- data ExplicitBuckets
- explicitBuckets :: ExplicitBuckets
- ebBounds :: Lens' ExplicitBuckets [Double]
- data AuthenticationInfo
- authenticationInfo :: AuthenticationInfo
- aiPrincipalEmail :: Lens' AuthenticationInfo (Maybe Text)
- aiAuthoritySelector :: Lens' AuthenticationInfo (Maybe Text)
- data AuditLog
- auditLog :: AuditLog
- alRequestMetadata :: Lens' AuditLog (Maybe RequestMetadata)
- alStatus :: Lens' AuditLog (Maybe Status)
- alResourceName :: Lens' AuditLog (Maybe Text)
- alAuthorizationInfo :: Lens' AuditLog [AuthorizationInfo]
- alServiceData :: Lens' AuditLog (Maybe AuditLogServiceData)
- alMethodName :: Lens' AuditLog (Maybe Text)
- alResponse :: Lens' AuditLog (Maybe AuditLogResponse)
- alServiceName :: Lens' AuditLog (Maybe Text)
- alNumResponseItems :: Lens' AuditLog (Maybe Int64)
- alAuthenticationInfo :: Lens' AuditLog (Maybe AuthenticationInfo)
- alRequest :: Lens' AuditLog (Maybe AuditLogRequest)
- data LogEntryStructPayload
- logEntryStructPayload :: HashMap Text JSONValue -> LogEntryStructPayload
- lespAddtional :: Lens' LogEntryStructPayload (HashMap Text JSONValue)
Service Configuration
serviceControlService :: ServiceConfig Source #
Default request referring to version v1
of the Google Service Control API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
serviceControlScope :: Proxy '["https://www.googleapis.com/auth/servicecontrol"] Source #
Manage your Google Service Control data
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
AuditLogServiceData
data AuditLogServiceData Source #
Other service-specific data about the request, response, and other activities.
See: auditLogServiceData
smart constructor.
Creates a value of AuditLogServiceData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alsdAddtional :: Lens' AuditLogServiceData (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
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.
RequestMetadata
data RequestMetadata Source #
Metadata about the request.
See: requestMetadata
smart constructor.
requestMetadata :: RequestMetadata Source #
Creates a value of RequestMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmCallerSuppliedUserAgent :: Lens' RequestMetadata (Maybe Text) Source #
The user agent of the caller. This information is not authenticated and should be treated accordingly. For example: + `google-api-python-client/1.4.0`: The request was made by the Google API client for Python. + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`: The request was made from the `my-project` App Engine app.
rmCallerIP :: Lens' RequestMetadata (Maybe Text) Source #
The IP address of the caller.
ReportRequest
data ReportRequest Source #
Request message for the Report method.
See: reportRequest
smart constructor.
reportRequest :: ReportRequest Source #
Creates a value of ReportRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrServiceConfigId :: Lens' ReportRequest (Maybe Text) Source #
Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.
rrOperations :: Lens' ReportRequest [Operation] Source #
Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. If multiple operations are in a single request, the total request size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior.
CheckRequest
data CheckRequest Source #
Request message for the Check method.
See: checkRequest
smart constructor.
checkRequest :: CheckRequest Source #
Creates a value of CheckRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crOperation :: Lens' CheckRequest (Maybe Operation) Source #
The operation to be checked.
crServiceConfigId :: Lens' CheckRequest (Maybe Text) Source #
Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.
MetricValueLabels
data MetricValueLabels Source #
The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship.
See: metricValueLabels
smart constructor.
Creates a value of MetricValueLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Distribution
data Distribution Source #
Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points
See: distribution
smart constructor.
distribution :: Distribution Source #
Creates a value of Distribution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dSumOfSquaredDeviation :: Lens' Distribution (Maybe Double) Source #
The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails.
dMean :: Lens' Distribution (Maybe Double) Source #
The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero.
dExponentialBuckets :: Lens' Distribution (Maybe ExponentialBuckets) Source #
Buckets with exponentially growing width.
dMaximum :: Lens' Distribution (Maybe Double) Source #
The maximum of the population of values. Ignored if `count` is zero.
dLinearBuckets :: Lens' Distribution (Maybe LinearBuckets) Source #
Buckets with constant width.
dCount :: Lens' Distribution (Maybe Int64) Source #
The total number of samples in the distribution. Must be >= 0.
dMinimum :: Lens' Distribution (Maybe Double) Source #
The minimum of the population of values. Ignored if `count` is zero.
dBucketCounts :: Lens' Distribution [Int64] Source #
The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted.
dExplicitBuckets :: Lens' Distribution (Maybe ExplicitBuckets) Source #
Buckets with arbitrary user-provided width.
ExponentialBuckets
data ExponentialBuckets Source #
Describing buckets with exponentially growing width.
See: exponentialBuckets
smart constructor.
exponentialBuckets :: ExponentialBuckets Source #
Creates a value of ExponentialBuckets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebGrowthFactor :: Lens' ExponentialBuckets (Maybe Double) Source #
The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0.
ebScale :: Lens' ExponentialBuckets (Maybe Double) Source #
The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.
ebNumFiniteBuckets :: Lens' ExponentialBuckets (Maybe Int32) Source #
The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.
AuthorizationInfo
data AuthorizationInfo Source #
Authorization information for the operation.
See: authorizationInfo
smart constructor.
authorizationInfo :: AuthorizationInfo Source #
Creates a value of AuthorizationInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiGranted :: Lens' AuthorizationInfo (Maybe Bool) Source #
Whether or not authorization for `resource` and `permission` was granted.
aiResource :: Lens' AuthorizationInfo (Maybe Text) Source #
The resource being accessed, as a REST-style string. For example: bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
aiPermission :: Lens' AuthorizationInfo (Maybe Text) Source #
The required IAM permission.
Operation
Represents information regarding an operation.
See: operation
smart constructor.
operation :: Operation Source #
Creates a value of Operation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oImportance :: Lens' Operation (Maybe OperationImportance) Source #
DO NOT USE. This is an experimental field.
oEndTime :: Lens' Operation (Maybe UTCTime) Source #
End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.
oOperationName :: Lens' Operation (Maybe Text) Source #
Fully qualified name of the operation. Reserved for future use.
oLabels :: Lens' Operation (Maybe OperationLabels) Source #
Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served (e.g. GAE, GCE, GKE).
oOperationId :: Lens' Operation (Maybe Text) Source #
Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.
oConsumerId :: Lens' Operation (Maybe Text) Source #
Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. This can be in one of the following formats: project:, project_number:, api_key:.
oMetricValueSets :: Lens' Operation [MetricValueSet] Source #
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
MetricValueSet
data MetricValueSet Source #
Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values.
See: metricValueSet
smart constructor.
metricValueSet :: MetricValueSet Source #
Creates a value of MetricValueSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mvsMetricName :: Lens' MetricValueSet (Maybe Text) Source #
The metric name defined in the service configuration.
mvsMetricValues :: Lens' MetricValueSet [MetricValue] Source #
The values in this metric.
LogEntryLabels
data LogEntryLabels Source #
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:
LogEntryProtoPayload
data LogEntryProtoPayload Source #
The log entry payload, represented as a protocol buffer that is expressed as a JSON object. You can only pass `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 'type with type URL.
LinearBuckets
data LinearBuckets Source #
Describing buckets with constant width.
See: linearBuckets
smart constructor.
linearBuckets :: LinearBuckets Source #
Creates a value of LinearBuckets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lbOffSet :: Lens' LinearBuckets (Maybe Double) Source #
The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive.
lbWidth :: Lens' LinearBuckets (Maybe Double) Source #
The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive.
lbNumFiniteBuckets :: Lens' LinearBuckets (Maybe Int32) Source #
The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.
CheckErrorCode
data CheckErrorCode Source #
The error code.
ErrorCodeUnspecified |
|
NotFound |
|
PermissionDenied |
|
ResourceExhausted |
|
ServiceNotActivated |
|
BillingDisabled |
|
ProjectDeleted |
|
ProjectInvalid |
|
IPAddressBlocked |
|
RefererBlocked |
|
ClientAppBlocked |
|
APITargetBlocked |
|
APIKeyInvalid |
|
APIKeyExpired |
|
APIKeyNotFound |
|
NamespaceLookupUnavailable |
|
ServiceStatusUnavailable |
|
BillingStatusUnavailable |
|
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 'type with type URL.
CheckError
data CheckError Source #
Defines the errors to be returned in google.api.servicecontrol.v1.CheckResponse.check_errors.
See: checkError
smart constructor.
checkError :: CheckError Source #
Creates a value of CheckError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ceCode :: Lens' CheckError (Maybe CheckErrorCode) Source #
The error code.
ceDetail :: Lens' CheckError (Maybe Text) Source #
Free-form text providing details on the error cause of the error.
ReportError
data ReportError Source #
Represents the processing error of one `Operation` in the request.
See: reportError
smart constructor.
reportError :: ReportError Source #
Creates a value of ReportError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
reStatus :: Lens' ReportError (Maybe Status) Source #
Details of the error when processing the `Operation`.
reOperationId :: Lens' ReportError (Maybe Text) Source #
The Operation.operation_id value from the request.
OperationImportance
data OperationImportance Source #
DO NOT USE. This is an experimental field.
Low |
|
High |
|
MetricValue
data MetricValue Source #
Represents a single metric value.
See: metricValue
smart constructor.
metricValue :: MetricValue Source #
Creates a value of MetricValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mvBoolValue :: Lens' MetricValue (Maybe Bool) Source #
A boolean value.
mvStartTime :: Lens' MetricValue (Maybe UTCTime) Source #
The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details.
mvDoubleValue :: Lens' MetricValue (Maybe Double) Source #
A double precision floating point value.
mvStringValue :: Lens' MetricValue (Maybe Text) Source #
A text string value.
mvDistributionValue :: Lens' MetricValue (Maybe Distribution) Source #
A distribution value.
mvEndTime :: Lens' MetricValue (Maybe UTCTime) Source #
The end of the time period over which this metric value's measurement applies.
mvInt64Value :: Lens' MetricValue (Maybe Int64) Source #
A signed 64-bit integer value.
mvLabels :: Lens' MetricValue (Maybe MetricValueLabels) Source #
The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship.
Xgafv
V1 error format.
AuditLogResponse
data AuditLogResponse Source #
The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `'type` property.
See: auditLogResponse
smart constructor.
Creates a value of AuditLogResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alrAddtional :: Lens' AuditLogResponse (HashMap Text JSONValue) Source #
Properties of the object.
CheckResponse
data CheckResponse Source #
Response message for the Check method.
See: checkResponse
smart constructor.
checkResponse :: CheckResponse Source #
Creates a value of CheckResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCheckErrors :: Lens' CheckResponse [CheckError] Source #
Indicate the decision of the check. If no check errors are present, the service should process the operation. Otherwise the service should use the list of errors to determine the appropriate action.
cServiceConfigId :: Lens' CheckResponse (Maybe Text) Source #
The actual config id used to process the request.
cOperationId :: Lens' CheckResponse (Maybe Text) Source #
The same operation_id value used in the CheckRequest. Used for logging and diagnostics purposes.
ReportResponse
data ReportResponse Source #
Response message for the Report method.
See: reportResponse
smart constructor.
reportResponse :: ReportResponse Source #
Creates a value of ReportResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rReportErrors :: Lens' ReportResponse [ReportError] Source #
Partial failures, one for each `Operation` in the request that failed processing. There are three possible combinations of the RPC status: 1. The combination of a successful RPC status and an empty `report_errors` list indicates a complete success where all `Operations` in the request are processed successfully. 2. The combination of a successful RPC status and a non-empty `report_errors` list indicates a partial success where some `Operations` in the request succeeded. Each `Operation` that failed processing has a corresponding item in this list. 3. A failed RPC status indicates a general non-deterministic failure. When this happens, it's impossible to know which of the 'Operations' in the request succeeded or failed.
rServiceConfigId :: Lens' ReportResponse (Maybe Text) Source #
The actual config id used to process the request.
LogEntry
An individual log entry.
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:
leSeverity :: Lens' LogEntry (Maybe LogEntrySeverity) Source #
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).
leStructPayload :: Lens' LogEntry (Maybe LogEntryStructPayload) Source #
The log entry payload, represented as a structure that is expressed as a JSON object.
leName :: Lens' LogEntry (Maybe Text) Source #
Required. The log to which this log entry belongs. Examples: `"syslog"`, `"book_log"`.
leInsertId :: Lens' LogEntry (Maybe Text) Source #
A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.
leLabels :: Lens' LogEntry (Maybe LogEntryLabels) Source #
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 that is expressed as a JSON object. You can only pass `protoPayload` values that belong to a set of approved types.
leTimestamp :: Lens' LogEntry (Maybe UTCTime) Source #
The time the event described by the log entry occurred. If omitted, defaults to operation start time.
AuditLogRequest
data AuditLogRequest Source #
The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `'type` property.
See: auditLogRequest
smart constructor.
Creates a value of AuditLogRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aAddtional :: Lens' AuditLogRequest (HashMap Text JSONValue) Source #
Properties of the object.
OperationLabels
data OperationLabels Source #
Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served (e.g. GAE, GCE, GKE).
See: operationLabels
smart constructor.
Creates a value of OperationLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
LogEntrySeverity
data LogEntrySeverity Source #
The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
Default |
|
Debug |
|
Info |
|
Notice |
|
Warning |
|
Error' |
|
Critical |
|
Alert |
|
Emergency |
|
ExplicitBuckets
data ExplicitBuckets Source #
Describing buckets with arbitrary user-provided width.
See: explicitBuckets
smart constructor.
explicitBuckets :: ExplicitBuckets Source #
Creates a value of ExplicitBuckets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebBounds :: Lens' ExplicitBuckets [Double] Source #
'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf
AuthenticationInfo
data AuthenticationInfo Source #
Authentication information for the operation.
See: authenticationInfo
smart constructor.
authenticationInfo :: AuthenticationInfo Source #
Creates a value of AuthenticationInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiPrincipalEmail :: Lens' AuthenticationInfo (Maybe Text) Source #
The email address of the authenticated user making the request.
aiAuthoritySelector :: Lens' AuthenticationInfo (Maybe Text) Source #
The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.
AuditLog
Common audit log format for Google Cloud Platform API operations.
See: auditLog
smart constructor.
Creates a value of AuditLog
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alRequestMetadata :: Lens' AuditLog (Maybe RequestMetadata) Source #
Metadata about the operation.
alResourceName :: Lens' AuditLog (Maybe Text) Source #
The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "shelves/SHELF_ID/books" "shelves/SHELF_ID/books/BOOK_ID"
alAuthorizationInfo :: Lens' AuditLog [AuthorizationInfo] Source #
Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
alServiceData :: Lens' AuditLog (Maybe AuditLogServiceData) Source #
Other service-specific data about the request, response, and other activities.
alMethodName :: Lens' AuditLog (Maybe Text) Source #
The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.datastore.v1.Datastore.RunQuery" "google.logging.v1.LoggingService.DeleteLog"
alResponse :: Lens' AuditLog (Maybe AuditLogResponse) Source #
The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `'type` property.
alServiceName :: Lens' AuditLog (Maybe Text) Source #
The name of the API service performing the operation. For example, `"datastore.googleapis.com"`.
alNumResponseItems :: Lens' AuditLog (Maybe Int64) Source #
The number of items returned from a List or Query API method, if applicable.
alAuthenticationInfo :: Lens' AuditLog (Maybe AuthenticationInfo) Source #
Authentication information.
alRequest :: Lens' AuditLog (Maybe AuditLogRequest) Source #
The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `'type` property.
LogEntryStructPayload
data LogEntryStructPayload Source #
The log entry payload, represented as a structure that is expressed as a JSON object.
See: logEntryStructPayload
smart constructor.
logEntryStructPayload Source #
Creates a value of LogEntryStructPayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lespAddtional :: Lens' LogEntryStructPayload (HashMap Text JSONValue) Source #
Properties of the object.