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
- MetricDescriptorValueType
- SystemParameter
- MonitoredResourceDescriptor
- DocumentationRule
- Status
- OperationSchema
- BillingDestination
- Control
- AuthRequirement
- Context
- LoggingDestination
- MetricDescriptor
- BackendRule
- SourceContext
- ListEnabledServicesResponse
- Field
- MetricRule
- FieldKind
- EnumSyntax
- Service
- Operation
- PublishedService
- EnableServiceRequest
- CustomErrorRule
- OptionValue
- EnumValue
- Authentication
- MetricDescriptorMetadataLaunchStage
- Mixin
- SearchServicesResponse
- CustomHTTPPattern
- UsageRule
- StatusDetailsItem
- Page
- AuthenticationRule
- StepStatus
- LabelDescriptorValueType
- MetricRuleMetricCosts
- AuthorizationConfig
- APISyntax
- TypeSyntax
- Experimental
- Backend
- Monitoring
- LogDescriptor
- Method
- SystemParameters
- Documentation
- Step
- Xgafv
- MetricDescriptorMetadata
- SystemParameterRule
- LabelDescriptor
- Usage
- FieldCardinality
- HTTP
- DisableServiceRequest
- Type
- API
- MonitoringDestination
- OperationMetadata
- Endpoint
- OAuthRequirements
- MetricDescriptorMetricKind
- CustomError
- QuotaLimit
- Option
- Billing
- SourceInfo
- QuotaLimitValues
- Enum'
- Logging
- MethodSyntax
- SourceInfoSourceFilesItem
- Quota
- HTTPRule
- OperationResponse
- AuthProvider
- ContextRule
Synopsis
- serviceUserService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- serviceManagementScope :: Proxy '["https://www.googleapis.com/auth/service.management"]
- data MetricDescriptorValueType
- data SystemParameter
- systemParameter :: SystemParameter
- spHTTPHeader :: Lens' SystemParameter (Maybe Text)
- spURLQueryParameter :: Lens' SystemParameter (Maybe Text)
- spName :: Lens' SystemParameter (Maybe Text)
- 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 DocumentationRule
- documentationRule :: DocumentationRule
- drSelector :: Lens' DocumentationRule (Maybe Text)
- drDeprecationDescription :: Lens' DocumentationRule (Maybe Text)
- drDescription :: Lens' DocumentationRule (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data OperationSchema
- operationSchema :: HashMap Text JSONValue -> OperationSchema
- osAddtional :: Lens' OperationSchema (HashMap Text JSONValue)
- data BillingDestination
- billingDestination :: BillingDestination
- bdMetrics :: Lens' BillingDestination [Text]
- bdMonitoredResource :: Lens' BillingDestination (Maybe Text)
- data Control
- control :: Control
- cEnvironment :: Lens' Control (Maybe Text)
- data AuthRequirement
- authRequirement :: AuthRequirement
- arProviderId :: Lens' AuthRequirement (Maybe Text)
- arAudiences :: Lens' AuthRequirement (Maybe Text)
- data Context
- context :: Context
- cRules :: Lens' Context [ContextRule]
- data LoggingDestination
- loggingDestination :: LoggingDestination
- ldMonitoredResource :: Lens' LoggingDestination (Maybe Text)
- ldLogs :: Lens' LoggingDestination [Text]
- data MetricDescriptor
- metricDescriptor :: MetricDescriptor
- mdMetricKind :: Lens' MetricDescriptor (Maybe MetricDescriptorMetricKind)
- mdName :: Lens' MetricDescriptor (Maybe Text)
- mdMetadata :: Lens' MetricDescriptor (Maybe MetricDescriptorMetadata)
- mdDisplayName :: Lens' MetricDescriptor (Maybe Text)
- mdLabels :: Lens' MetricDescriptor [LabelDescriptor]
- mdType :: Lens' MetricDescriptor (Maybe Text)
- mdValueType :: Lens' MetricDescriptor (Maybe MetricDescriptorValueType)
- mdDescription :: Lens' MetricDescriptor (Maybe Text)
- mdUnit :: Lens' MetricDescriptor (Maybe Text)
- data BackendRule
- backendRule :: BackendRule
- brSelector :: Lens' BackendRule (Maybe Text)
- brMinDeadline :: Lens' BackendRule (Maybe Double)
- brAddress :: Lens' BackendRule (Maybe Text)
- brDeadline :: Lens' BackendRule (Maybe Double)
- data SourceContext
- sourceContext :: SourceContext
- scFileName :: Lens' SourceContext (Maybe Text)
- data ListEnabledServicesResponse
- listEnabledServicesResponse :: ListEnabledServicesResponse
- lesrNextPageToken :: Lens' ListEnabledServicesResponse (Maybe Text)
- lesrServices :: Lens' ListEnabledServicesResponse [PublishedService]
- data Field
- field :: Field
- fKind :: Lens' Field (Maybe FieldKind)
- fOneofIndex :: Lens' Field (Maybe Int32)
- fName :: Lens' Field (Maybe Text)
- fJSONName :: Lens' Field (Maybe Text)
- fCardinality :: Lens' Field (Maybe FieldCardinality)
- fOptions :: Lens' Field [Option]
- fPacked :: Lens' Field (Maybe Bool)
- fDefaultValue :: Lens' Field (Maybe Text)
- fNumber :: Lens' Field (Maybe Int32)
- fTypeURL :: Lens' Field (Maybe Text)
- data MetricRule
- metricRule :: MetricRule
- mrSelector :: Lens' MetricRule (Maybe Text)
- mrMetricCosts :: Lens' MetricRule (Maybe MetricRuleMetricCosts)
- data FieldKind
- data EnumSyntax
- data Service
- service :: Service
- sControl :: Lens' Service (Maybe Control)
- sMetrics :: Lens' Service [MetricDescriptor]
- sContext :: Lens' Service (Maybe Context)
- sAuthentication :: Lens' Service (Maybe Authentication)
- sAPIs :: Lens' Service [API]
- sTypes :: Lens' Service [Type]
- sSystemTypes :: Lens' Service [Type]
- sExperimental :: Lens' Service (Maybe Experimental)
- sMonitoredResources :: Lens' Service [MonitoredResourceDescriptor]
- sBackend :: Lens' Service (Maybe Backend)
- sMonitoring :: Lens' Service (Maybe Monitoring)
- sName :: Lens' Service (Maybe Text)
- sSystemParameters :: Lens' Service (Maybe SystemParameters)
- sLogs :: Lens' Service [LogDescriptor]
- sDocumentation :: Lens' Service (Maybe Documentation)
- sId :: Lens' Service (Maybe Text)
- sUsage :: Lens' Service (Maybe Usage)
- sEndpoints :: Lens' Service [Endpoint]
- sEnums :: Lens' Service [Enum']
- sConfigVersion :: Lens' Service (Maybe Word32)
- sHTTP :: Lens' Service (Maybe HTTP)
- sTitle :: Lens' Service (Maybe Text)
- sProducerProjectId :: Lens' Service (Maybe Text)
- sSourceInfo :: Lens' Service (Maybe SourceInfo)
- sBilling :: Lens' Service (Maybe Billing)
- sCustomError :: Lens' Service (Maybe CustomError)
- sLogging :: Lens' Service (Maybe Logging)
- sQuota :: Lens' Service (Maybe Quota)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationSchema)
- data PublishedService
- publishedService :: PublishedService
- psService :: Lens' PublishedService (Maybe Service)
- psName :: Lens' PublishedService (Maybe Text)
- data EnableServiceRequest
- enableServiceRequest :: EnableServiceRequest
- data CustomErrorRule
- customErrorRule :: CustomErrorRule
- cerIsErrorType :: Lens' CustomErrorRule (Maybe Bool)
- cerSelector :: Lens' CustomErrorRule (Maybe Text)
- data OptionValue
- optionValue :: HashMap Text JSONValue -> OptionValue
- ovAddtional :: Lens' OptionValue (HashMap Text JSONValue)
- data EnumValue
- enumValue :: EnumValue
- evName :: Lens' EnumValue (Maybe Text)
- evOptions :: Lens' EnumValue [Option]
- evNumber :: Lens' EnumValue (Maybe Int32)
- data Authentication
- authentication :: Authentication
- aRules :: Lens' Authentication [AuthenticationRule]
- aProviders :: Lens' Authentication [AuthProvider]
- data MetricDescriptorMetadataLaunchStage
- data Mixin
- mixin :: Mixin
- mRoot :: Lens' Mixin (Maybe Text)
- mName :: Lens' Mixin (Maybe Text)
- data SearchServicesResponse
- searchServicesResponse :: SearchServicesResponse
- ssrNextPageToken :: Lens' SearchServicesResponse (Maybe Text)
- ssrServices :: Lens' SearchServicesResponse [PublishedService]
- data CustomHTTPPattern
- customHTTPPattern :: CustomHTTPPattern
- chttppPath :: Lens' CustomHTTPPattern (Maybe Text)
- chttppKind :: Lens' CustomHTTPPattern (Maybe Text)
- data UsageRule
- usageRule :: UsageRule
- urSelector :: Lens' UsageRule (Maybe Text)
- urAllowUnregisteredCalls :: Lens' UsageRule (Maybe Bool)
- urSkipServiceControl :: Lens' UsageRule (Maybe Bool)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data Page
- page :: Page
- pSubpages :: Lens' Page [Page]
- pContent :: Lens' Page (Maybe Text)
- pName :: Lens' Page (Maybe Text)
- data AuthenticationRule
- authenticationRule :: AuthenticationRule
- arRequirements :: Lens' AuthenticationRule [AuthRequirement]
- arSelector :: Lens' AuthenticationRule (Maybe Text)
- arAllowWithoutCredential :: Lens' AuthenticationRule (Maybe Bool)
- arOAuth :: Lens' AuthenticationRule (Maybe OAuthRequirements)
- data StepStatus
- data LabelDescriptorValueType
- data MetricRuleMetricCosts
- metricRuleMetricCosts :: HashMap Text Int64 -> MetricRuleMetricCosts
- mrmcAddtional :: Lens' MetricRuleMetricCosts (HashMap Text Int64)
- data AuthorizationConfig
- authorizationConfig :: AuthorizationConfig
- acProvider :: Lens' AuthorizationConfig (Maybe Text)
- data APISyntax
- data TypeSyntax
- data Experimental
- experimental :: Experimental
- eAuthorization :: Lens' Experimental (Maybe AuthorizationConfig)
- data Backend
- backend :: Backend
- bRules :: Lens' Backend [BackendRule]
- data Monitoring
- monitoring :: Monitoring
- mProducerDestinations :: Lens' Monitoring [MonitoringDestination]
- mConsumerDestinations :: Lens' Monitoring [MonitoringDestination]
- data LogDescriptor
- logDescriptor :: LogDescriptor
- ldName :: Lens' LogDescriptor (Maybe Text)
- ldDisplayName :: Lens' LogDescriptor (Maybe Text)
- ldLabels :: Lens' LogDescriptor [LabelDescriptor]
- ldDescription :: Lens' LogDescriptor (Maybe Text)
- data Method
- method :: Method
- metRequestStreaming :: Lens' Method (Maybe Bool)
- metResponseTypeURL :: Lens' Method (Maybe Text)
- metName :: Lens' Method (Maybe Text)
- metResponseStreaming :: Lens' Method (Maybe Bool)
- metRequestTypeURL :: Lens' Method (Maybe Text)
- metOptions :: Lens' Method [Option]
- metSyntax :: Lens' Method (Maybe MethodSyntax)
- data SystemParameters
- systemParameters :: SystemParameters
- spRules :: Lens' SystemParameters [SystemParameterRule]
- data Documentation
- documentation :: Documentation
- dSummary :: Lens' Documentation (Maybe Text)
- dDocumentationRootURL :: Lens' Documentation (Maybe Text)
- dRules :: Lens' Documentation [DocumentationRule]
- dPages :: Lens' Documentation [Page]
- dOverview :: Lens' Documentation (Maybe Text)
- data Step
- step :: Step
- sStatus :: Lens' Step (Maybe StepStatus)
- sDescription :: Lens' Step (Maybe Text)
- data Xgafv
- data MetricDescriptorMetadata
- metricDescriptorMetadata :: MetricDescriptorMetadata
- mdmSamplePeriod :: Lens' MetricDescriptorMetadata (Maybe Scientific)
- mdmIngestDelay :: Lens' MetricDescriptorMetadata (Maybe Scientific)
- mdmLaunchStage :: Lens' MetricDescriptorMetadata (Maybe MetricDescriptorMetadataLaunchStage)
- data SystemParameterRule
- systemParameterRule :: SystemParameterRule
- sprSelector :: Lens' SystemParameterRule (Maybe Text)
- sprParameters :: Lens' SystemParameterRule [SystemParameter]
- data LabelDescriptor
- labelDescriptor :: LabelDescriptor
- lKey :: Lens' LabelDescriptor (Maybe Text)
- lValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType)
- lDescription :: Lens' LabelDescriptor (Maybe Text)
- data Usage
- usage :: Usage
- uRequirements :: Lens' Usage [Text]
- uRules :: Lens' Usage [UsageRule]
- uProducerNotificationChannel :: Lens' Usage (Maybe Text)
- data FieldCardinality
- data HTTP
- hTTP :: HTTP
- hRules :: Lens' HTTP [HTTPRule]
- hFullyDecodeReservedExpansion :: Lens' HTTP (Maybe Bool)
- data DisableServiceRequest
- disableServiceRequest :: DisableServiceRequest
- data Type
- type' :: Type
- tSourceContext :: Lens' Type (Maybe SourceContext)
- tOneofs :: Lens' Type [Text]
- tName :: Lens' Type (Maybe Text)
- tOptions :: Lens' Type [Option]
- tFields :: Lens' Type [Field]
- tSyntax :: Lens' Type (Maybe TypeSyntax)
- data API
- api :: API
- aSourceContext :: Lens' API (Maybe SourceContext)
- aMixins :: Lens' API [Mixin]
- aMethods :: Lens' API [Method]
- aName :: Lens' API (Maybe Text)
- aVersion :: Lens' API (Maybe Text)
- aOptions :: Lens' API [Option]
- aSyntax :: Lens' API (Maybe APISyntax)
- data MonitoringDestination
- monitoringDestination :: MonitoringDestination
- mdMetrics :: Lens' MonitoringDestination [Text]
- mdMonitoredResource :: Lens' MonitoringDestination (Maybe Text)
- data OperationMetadata
- operationMetadata :: OperationMetadata
- omStartTime :: Lens' OperationMetadata (Maybe UTCTime)
- omSteps :: Lens' OperationMetadata [Step]
- omProgressPercentage :: Lens' OperationMetadata (Maybe Int32)
- omResourceNames :: Lens' OperationMetadata [Text]
- data Endpoint
- endpoint :: Endpoint
- eAliases :: Lens' Endpoint [Text]
- eAllowCORS :: Lens' Endpoint (Maybe Bool)
- eName :: Lens' Endpoint (Maybe Text)
- eFeatures :: Lens' Endpoint [Text]
- eTarget :: Lens' Endpoint (Maybe Text)
- data OAuthRequirements
- oAuthRequirements :: OAuthRequirements
- oarCanonicalScopes :: Lens' OAuthRequirements (Maybe Text)
- data MetricDescriptorMetricKind
- data CustomError
- customError :: CustomError
- ceRules :: Lens' CustomError [CustomErrorRule]
- ceTypes :: Lens' CustomError [Text]
- data QuotaLimit
- quotaLimit :: QuotaLimit
- qlValues :: Lens' QuotaLimit (Maybe QuotaLimitValues)
- qlFreeTier :: Lens' QuotaLimit (Maybe Int64)
- qlMetric :: Lens' QuotaLimit (Maybe Text)
- qlName :: Lens' QuotaLimit (Maybe Text)
- qlDisplayName :: Lens' QuotaLimit (Maybe Text)
- qlDuration :: Lens' QuotaLimit (Maybe Text)
- qlDefaultLimit :: Lens' QuotaLimit (Maybe Int64)
- qlDescription :: Lens' QuotaLimit (Maybe Text)
- qlUnit :: Lens' QuotaLimit (Maybe Text)
- qlMaxLimit :: Lens' QuotaLimit (Maybe Int64)
- data Option
- option :: Option
- optValue :: Lens' Option (Maybe OptionValue)
- optName :: Lens' Option (Maybe Text)
- data Billing
- billing :: Billing
- bConsumerDestinations :: Lens' Billing [BillingDestination]
- data SourceInfo
- sourceInfo :: SourceInfo
- siSourceFiles :: Lens' SourceInfo [SourceInfoSourceFilesItem]
- data QuotaLimitValues
- quotaLimitValues :: HashMap Text Int64 -> QuotaLimitValues
- qlvAddtional :: Lens' QuotaLimitValues (HashMap Text Int64)
- data Enum'
- enum :: Enum'
- enuSourceContext :: Lens' Enum' (Maybe SourceContext)
- enuEnumvalue :: Lens' Enum' [EnumValue]
- enuName :: Lens' Enum' (Maybe Text)
- enuOptions :: Lens' Enum' [Option]
- enuSyntax :: Lens' Enum' (Maybe EnumSyntax)
- data Logging
- logging :: Logging
- lProducerDestinations :: Lens' Logging [LoggingDestination]
- lConsumerDestinations :: Lens' Logging [LoggingDestination]
- data MethodSyntax
- data SourceInfoSourceFilesItem
- sourceInfoSourceFilesItem :: HashMap Text JSONValue -> SourceInfoSourceFilesItem
- sisfiAddtional :: Lens' SourceInfoSourceFilesItem (HashMap Text JSONValue)
- data Quota
- quota :: Quota
- qLimits :: Lens' Quota [QuotaLimit]
- qMetricRules :: Lens' Quota [MetricRule]
- data HTTPRule
- hTTPRule :: HTTPRule
- httprSelector :: Lens' HTTPRule (Maybe Text)
- httprPost :: Lens' HTTPRule (Maybe Text)
- httprBody :: Lens' HTTPRule (Maybe Text)
- httprCustom :: Lens' HTTPRule (Maybe CustomHTTPPattern)
- httprResponseBody :: Lens' HTTPRule (Maybe Text)
- httprPatch :: Lens' HTTPRule (Maybe Text)
- httprGet :: Lens' HTTPRule (Maybe Text)
- httprAdditionalBindings :: Lens' HTTPRule [HTTPRule]
- httprDelete :: Lens' HTTPRule (Maybe Text)
- httprPut :: Lens' HTTPRule (Maybe Text)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data AuthProvider
- authProvider :: AuthProvider
- apJWKsURI :: Lens' AuthProvider (Maybe Text)
- apAudiences :: Lens' AuthProvider (Maybe Text)
- apId :: Lens' AuthProvider (Maybe Text)
- apAuthorizationURL :: Lens' AuthProvider (Maybe Text)
- apIssuer :: Lens' AuthProvider (Maybe Text)
- data ContextRule
- contextRule :: ContextRule
- crSelector :: Lens' ContextRule (Maybe Text)
- crRequested :: Lens' ContextRule [Text]
- crAllowedRequestExtensions :: Lens' ContextRule [Text]
- crProvided :: Lens' ContextRule [Text]
- crAllowedResponseExtensions :: Lens' ContextRule [Text]
Service Configuration
serviceUserService :: ServiceConfig Source #
Default request referring to version v1
of the Service User API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
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
serviceManagementScope :: Proxy '["https://www.googleapis.com/auth/service.management"] Source #
Manage your Google API service configuration
MetricDescriptorValueType
data MetricDescriptorValueType Source #
Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
ValueTypeUnspecified |
|
Bool |
|
INT64 |
|
Double |
|
String |
|
Distribution |
|
Money |
|
Instances
SystemParameter
data SystemParameter Source #
Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
See: systemParameter
smart constructor.
Instances
systemParameter :: SystemParameter Source #
Creates a value of SystemParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spHTTPHeader :: Lens' SystemParameter (Maybe Text) Source #
Define the HTTP header name to use for the parameter. It is case insensitive.
spURLQueryParameter :: Lens' SystemParameter (Maybe Text) Source #
Define the URL query parameter name to use for the parameter. It is case sensitive.
spName :: Lens' SystemParameter (Maybe Text) Source #
Define the name of the parameter, such as "api_key" . It is case sensitive.
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.
Instances
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. It should be a Title Cased Noun Phrase, without any article or other determiners. 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. The maximum length of this value is 256 characters.
mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. A detailed description of the monitored resource type that might be used in documentation.
DocumentationRule
data DocumentationRule Source #
A documentation rule provides information about individual API elements.
See: documentationRule
smart constructor.
Instances
documentationRule :: DocumentationRule Source #
Creates a value of DocumentationRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drSelector :: Lens' DocumentationRule (Maybe Text) Source #
The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To specify a default for all applicable elements, the whole pattern "*" is used.
drDeprecationDescription :: Lens' DocumentationRule (Maybe Text) Source #
Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
drDescription :: Lens' DocumentationRule (Maybe Text) Source #
Description of the selected API(s).
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` that 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. - 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.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is 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.
OperationSchema
data OperationSchema Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
See: operationSchema
smart constructor.
Instances
Creates a value of OperationSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osAddtional :: Lens' OperationSchema (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
BillingDestination
data BillingDestination Source #
Configuration of a specific billing destination (Currently only support bill against consumer project).
See: billingDestination
smart constructor.
Instances
billingDestination :: BillingDestination Source #
Creates a value of BillingDestination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdMetrics :: Lens' BillingDestination [Text] Source #
Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
bdMonitoredResource :: Lens' BillingDestination (Maybe Text) Source #
The monitored resource type. The type must be defined in Service.monitored_resources section.
Control
Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
See: control
smart constructor.
Instances
Eq Control Source # | |
Data Control Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Control -> c Control # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Control # toConstr :: Control -> Constr # dataTypeOf :: Control -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Control) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Control) # gmapT :: (forall b. Data b => b -> b) -> Control -> Control # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Control -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Control -> r # gmapQ :: (forall d. Data d => d -> u) -> Control -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Control -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Control -> m Control # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Control -> m Control # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Control -> m Control # | |
Show Control Source # | |
Generic Control Source # | |
ToJSON Control Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Control Source # | |
type Rep Control Source # | |
Defined in Network.Google.ServiceUser.Types.Product |
Creates a value of Control
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cEnvironment :: Lens' Control (Maybe Text) Source #
The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
AuthRequirement
data AuthRequirement Source #
User-defined authentication requirements, including support for JSON Web Token (JWT).
See: authRequirement
smart constructor.
Instances
authRequirement :: AuthRequirement Source #
Creates a value of AuthRequirement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arProviderId :: Lens' AuthRequirement (Maybe Text) Source #
id from authentication provider. Example: provider_id: bookstore_auth
arAudiences :: Lens' AuthRequirement (Maybe Text) Source #
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
Context
`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.
See: context
smart constructor.
Instances
Eq Context Source # | |
Data Context Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Context -> c Context # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Context # toConstr :: Context -> Constr # dataTypeOf :: Context -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Context) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Context) # gmapT :: (forall b. Data b => b -> b) -> Context -> Context # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Context -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Context -> r # gmapQ :: (forall d. Data d => d -> u) -> Context -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Context -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Context -> m Context # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Context -> m Context # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Context -> m Context # | |
Show Context Source # | |
Generic Context Source # | |
ToJSON Context Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Context Source # | |
type Rep Context Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Context = D1 (MetaData "Context" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" True) (C1 (MetaCons "Context'" PrefixI True) (S1 (MetaSel (Just "_cRules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ContextRule])))) |
cRules :: Lens' Context [ContextRule] Source #
A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
LoggingDestination
data LoggingDestination Source #
Configuration of a specific logging destination (the producer project or the consumer project).
See: loggingDestination
smart constructor.
Instances
loggingDestination :: LoggingDestination Source #
Creates a value of LoggingDestination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldMonitoredResource :: Lens' LoggingDestination (Maybe Text) Source #
The monitored resource type. The type must be defined in the Service.monitored_resources section.
ldLogs :: Lens' LoggingDestination [Text] Source #
Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
MetricDescriptor
data MetricDescriptor Source #
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
See: metricDescriptor
smart constructor.
Instances
metricDescriptor :: MetricDescriptor Source #
Creates a value of MetricDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdMetricKind :: Lens' MetricDescriptor (Maybe MetricDescriptorMetricKind) Source #
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
mdMetadata :: Lens' MetricDescriptor (Maybe MetricDescriptorMetadata) Source #
Optional. Metadata which can be used to guide usage of the metric.
mdDisplayName :: Lens' MetricDescriptor (Maybe Text) Source #
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
mdLabels :: Lens' MetricDescriptor [LabelDescriptor] Source #
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
mdType :: Lens' MetricDescriptor (Maybe Text) Source #
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
mdValueType :: Lens' MetricDescriptor (Maybe MetricDescriptorValueType) Source #
Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
mdDescription :: Lens' MetricDescriptor (Maybe Text) Source #
A detailed description of the metric, which can be used in documentation.
mdUnit :: Lens' MetricDescriptor (Maybe Text) Source #
The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of The Unified Code for Units of Measure standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage.
BackendRule
data BackendRule Source #
A backend rule provides configuration for an individual API element.
See: backendRule
smart constructor.
Instances
backendRule :: BackendRule Source #
Creates a value of BackendRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brSelector :: Lens' BackendRule (Maybe Text) Source #
Selects the methods to which this rule applies. Refer to selector for syntax details.
brMinDeadline :: Lens' BackendRule (Maybe Double) Source #
Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
brDeadline :: Lens' BackendRule (Maybe Double) Source #
The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
SourceContext
data SourceContext Source #
`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.
See: sourceContext
smart constructor.
Instances
sourceContext :: SourceContext Source #
Creates a value of SourceContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scFileName :: Lens' SourceContext (Maybe Text) Source #
The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.
ListEnabledServicesResponse
data ListEnabledServicesResponse Source #
Response message for `ListEnabledServices` method.
See: listEnabledServicesResponse
smart constructor.
Instances
listEnabledServicesResponse :: ListEnabledServicesResponse Source #
Creates a value of ListEnabledServicesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lesrNextPageToken :: Lens' ListEnabledServicesResponse (Maybe Text) Source #
Token that can be passed to `ListEnabledServices` to resume a paginated query.
lesrServices :: Lens' ListEnabledServicesResponse [PublishedService] Source #
Services enabled for the specified parent.
Field
A single field of a message type.
See: field
smart constructor.
Instances
Creates a value of Field
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fOneofIndex :: Lens' Field (Maybe Int32) Source #
The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
fCardinality :: Lens' Field (Maybe FieldCardinality) Source #
The field cardinality.
fDefaultValue :: Lens' Field (Maybe Text) Source #
The string value of the default value of this field. Proto2 syntax only.
fTypeURL :: Lens' Field (Maybe Text) Source #
The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
MetricRule
data MetricRule Source #
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.
See: metricRule
smart constructor.
Instances
metricRule :: MetricRule Source #
Creates a value of MetricRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrSelector :: Lens' MetricRule (Maybe Text) Source #
Selects the methods to which this rule applies. Refer to selector for syntax details.
mrMetricCosts :: Lens' MetricRule (Maybe MetricRuleMetricCosts) Source #
Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
FieldKind
The field type.
TypeUnknown |
|
TypeDouble |
|
TypeFloat |
|
TypeINT64 |
|
TypeUINT64 |
|
TypeINT32 |
|
TypeFIXED64 |
|
TypeFIXED32 |
|
TypeBool |
|
TypeString |
|
TypeGroup |
|
TypeMessage |
|
TypeBytes |
|
TypeUINT32 |
|
TypeEnum |
|
TypeSFIXED32 |
|
TypeSFIXED64 |
|
TypeSINT32 |
|
TypeSINT64 |
|
Instances
EnumSyntax
data EnumSyntax Source #
The source syntax.
SyntaxPROTO2 |
|
SyntaxPROTO3 |
|
Instances
Service
`Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth
See: service
smart constructor.
Instances
Creates a value of Service
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sAuthentication :: Lens' Service (Maybe Authentication) Source #
Auth configuration.
sAPIs :: Lens' Service [API] Source #
A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
sTypes :: Lens' Service [Type] Source #
A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32
sSystemTypes :: Lens' Service [Type] Source #
A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
sExperimental :: Lens' Service (Maybe Experimental) Source #
Experimental configuration.
sMonitoredResources :: Lens' Service [MonitoredResourceDescriptor] Source #
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
sMonitoring :: Lens' Service (Maybe Monitoring) Source #
Monitoring configuration.
sName :: Lens' Service (Maybe Text) Source #
The DNS address at which this service is available, e.g. `calendar.googleapis.com`.
sSystemParameters :: Lens' Service (Maybe SystemParameters) Source #
System parameter configuration.
sDocumentation :: Lens' Service (Maybe Documentation) Source #
Additional API documentation.
sId :: Lens' Service (Maybe Text) Source #
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters.
sEndpoints :: Lens' Service [Endpoint] Source #
Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
sEnums :: Lens' Service [Enum'] Source #
A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum
sConfigVersion :: Lens' Service (Maybe Word32) Source #
The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.
sSourceInfo :: Lens' Service (Maybe SourceInfo) Source #
Output only. The source information for this configuration if available.
sCustomError :: Lens' Service (Maybe CustomError) Source #
Custom error configuration.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationSchema) Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
PublishedService
data PublishedService Source #
The published version of a Service that is managed by Google Service Management.
See: publishedService
smart constructor.
Instances
publishedService :: PublishedService Source #
Creates a value of PublishedService
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psName :: Lens' PublishedService (Maybe Text) Source #
The resource name of the service. A valid name would be: - services/serviceuser.googleapis.com
EnableServiceRequest
data EnableServiceRequest Source #
Request message for EnableService method.
See: enableServiceRequest
smart constructor.
Instances
enableServiceRequest :: EnableServiceRequest Source #
Creates a value of EnableServiceRequest
with the minimum fields required to make a request.
CustomErrorRule
data CustomErrorRule Source #
A custom error rule.
See: customErrorRule
smart constructor.
Instances
customErrorRule :: CustomErrorRule Source #
Creates a value of CustomErrorRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cerIsErrorType :: Lens' CustomErrorRule (Maybe Bool) Source #
Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
cerSelector :: Lens' CustomErrorRule (Maybe Text) Source #
Selects messages to which this rule applies. Refer to selector for syntax details.
OptionValue
data OptionValue Source #
The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
See: optionValue
smart constructor.
Instances
Creates a value of OptionValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ovAddtional :: Lens' OptionValue (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
EnumValue
Enum value definition.
See: enumValue
smart constructor.
Instances
Eq EnumValue Source # | |
Data EnumValue Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnumValue -> c EnumValue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnumValue # toConstr :: EnumValue -> Constr # dataTypeOf :: EnumValue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EnumValue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnumValue) # gmapT :: (forall b. Data b => b -> b) -> EnumValue -> EnumValue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnumValue -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnumValue -> r # gmapQ :: (forall d. Data d => d -> u) -> EnumValue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EnumValue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnumValue -> m EnumValue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnumValue -> m EnumValue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnumValue -> m EnumValue # | |
Show EnumValue Source # | |
Generic EnumValue Source # | |
ToJSON EnumValue Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON EnumValue Source # | |
type Rep EnumValue Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep EnumValue = D1 (MetaData "EnumValue" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "EnumValue'" PrefixI True) (S1 (MetaSel (Just "_evName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_evOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Option])) :*: S1 (MetaSel (Just "_evNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) |
Authentication
data Authentication Source #
`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth
See: authentication
smart constructor.
Instances
authentication :: Authentication Source #
Creates a value of Authentication
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aRules :: Lens' Authentication [AuthenticationRule] Source #
A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
aProviders :: Lens' Authentication [AuthProvider] Source #
Defines a set of authentication providers that a service supports.
MetricDescriptorMetadataLaunchStage
data MetricDescriptorMetadataLaunchStage Source #
The launch stage of the metric definition.
LaunchStageUnspecified |
|
EarlyAccess |
|
Alpha |
|
Beta |
|
GA |
|
Deprecated |
|
Instances
Mixin
Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }
See: mixin
smart constructor.
Instances
Eq Mixin Source # | |
Data Mixin Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mixin -> c Mixin # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mixin # dataTypeOf :: Mixin -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mixin) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mixin) # gmapT :: (forall b. Data b => b -> b) -> Mixin -> Mixin # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mixin -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mixin -> r # gmapQ :: (forall d. Data d => d -> u) -> Mixin -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Mixin -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mixin -> m Mixin # | |
Show Mixin Source # | |
Generic Mixin Source # | |
ToJSON Mixin Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Mixin Source # | |
type Rep Mixin Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Mixin = D1 (MetaData "Mixin" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Mixin'" PrefixI True) (S1 (MetaSel (Just "_mRoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
mRoot :: Lens' Mixin (Maybe Text) Source #
If non-empty specifies a path under which inherited HTTP paths are rooted.
mName :: Lens' Mixin (Maybe Text) Source #
The fully qualified name of the interface which is included.
SearchServicesResponse
data SearchServicesResponse Source #
Response message for SearchServices method.
See: searchServicesResponse
smart constructor.
Instances
searchServicesResponse :: SearchServicesResponse Source #
Creates a value of SearchServicesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssrNextPageToken :: Lens' SearchServicesResponse (Maybe Text) Source #
Token that can be passed to `ListAvailableServices` to resume a paginated query.
ssrServices :: Lens' SearchServicesResponse [PublishedService] Source #
Services available publicly or available to the authenticated caller.
CustomHTTPPattern
data CustomHTTPPattern Source #
A custom pattern is used for defining custom HTTP verb.
See: customHTTPPattern
smart constructor.
Instances
customHTTPPattern :: CustomHTTPPattern Source #
Creates a value of CustomHTTPPattern
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
chttppPath :: Lens' CustomHTTPPattern (Maybe Text) Source #
The path matched by this custom verb.
chttppKind :: Lens' CustomHTTPPattern (Maybe Text) Source #
The name of this custom HTTP verb.
UsageRule
Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true
See: usageRule
smart constructor.
Instances
Eq UsageRule Source # | |
Data UsageRule Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsageRule -> c UsageRule # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsageRule # toConstr :: UsageRule -> Constr # dataTypeOf :: UsageRule -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsageRule) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsageRule) # gmapT :: (forall b. Data b => b -> b) -> UsageRule -> UsageRule # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsageRule -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsageRule -> r # gmapQ :: (forall d. Data d => d -> u) -> UsageRule -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsageRule -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsageRule -> m UsageRule # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsageRule -> m UsageRule # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsageRule -> m UsageRule # | |
Show UsageRule Source # | |
Generic UsageRule Source # | |
ToJSON UsageRule Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON UsageRule Source # | |
type Rep UsageRule Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep UsageRule = D1 (MetaData "UsageRule" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "UsageRule'" PrefixI True) (S1 (MetaSel (Just "_urSelector") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_urAllowUnregisteredCalls") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_urSkipServiceControl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) |
usageRule :: UsageRule Source #
Creates a value of UsageRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urSelector :: Lens' UsageRule (Maybe Text) Source #
Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
urAllowUnregisteredCalls :: Lens' UsageRule (Maybe Bool) Source #
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
urSkipServiceControl :: Lens' UsageRule (Maybe Bool) Source #
If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
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.
Page
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
See: page
smart constructor.
Instances
Eq Page Source # | |
Data Page Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Page -> c Page # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Page # dataTypeOf :: Page -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Page) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Page) # gmapT :: (forall b. Data b => b -> b) -> Page -> Page # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Page -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Page -> r # gmapQ :: (forall d. Data d => d -> u) -> Page -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Page -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Page -> m Page # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Page -> m Page # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Page -> m Page # | |
Show Page Source # | |
Generic Page Source # | |
ToJSON Page Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Page Source # | |
type Rep Page Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Page = D1 (MetaData "Page" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Page'" PrefixI True) (S1 (MetaSel (Just "_pSubpages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Page])) :*: (S1 (MetaSel (Just "_pContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
pSubpages :: Lens' Page [Page] Source #
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
pContent :: Lens' Page (Maybe Text) Source #
The Markdown content of the page. You can use '(== include {path} ==)' to include content from a Markdown file.
pName :: Lens' Page (Maybe Text) Source #
The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example:
pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can reference `Java` page using Markdown reference link syntax: `Java`.
AuthenticationRule
data AuthenticationRule Source #
Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.
See: authenticationRule
smart constructor.
Instances
authenticationRule :: AuthenticationRule Source #
Creates a value of AuthenticationRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arRequirements :: Lens' AuthenticationRule [AuthRequirement] Source #
Requirements for additional authentication providers.
arSelector :: Lens' AuthenticationRule (Maybe Text) Source #
Selects the methods to which this rule applies. Refer to selector for syntax details.
arAllowWithoutCredential :: Lens' AuthenticationRule (Maybe Bool) Source #
If true, the service accepts API keys without any other credential.
arOAuth :: Lens' AuthenticationRule (Maybe OAuthRequirements) Source #
The requirements for OAuth credentials.
StepStatus
data StepStatus Source #
The status code.
StatusUnspecified |
|
Done |
|
NotStarted |
|
InProgress |
|
Failed |
|
Cancelled |
|
Instances
LabelDescriptorValueType
data LabelDescriptorValueType Source #
The type of data that can be assigned to the label.
LDVTString |
|
LDVTBool |
|
LDVTINT64 |
|
Instances
MetricRuleMetricCosts
data MetricRuleMetricCosts Source #
Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
See: metricRuleMetricCosts
smart constructor.
Instances
metricRuleMetricCosts Source #
Creates a value of MetricRuleMetricCosts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
AuthorizationConfig
data AuthorizationConfig Source #
Configuration of authorization. This section determines the authorization provider, if unspecified, then no authorization check will be done. Example: experimental: authorization: provider: firebaserules.googleapis.com
See: authorizationConfig
smart constructor.
Instances
authorizationConfig :: AuthorizationConfig Source #
Creates a value of AuthorizationConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acProvider :: Lens' AuthorizationConfig (Maybe Text) Source #
The name of the authorization provider, such as firebaserules.googleapis.com.
APISyntax
The source syntax of the service.
ASSyntaxPROTO2 |
|
ASSyntaxPROTO3 |
|
Instances
TypeSyntax
data TypeSyntax Source #
The source syntax.
TSSyntaxPROTO2 |
|
TSSyntaxPROTO3 |
|
Instances
Experimental
data Experimental Source #
Experimental service configuration. These configuration options can only be used by whitelisted users.
See: experimental
smart constructor.
Instances
experimental :: Experimental Source #
Creates a value of Experimental
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eAuthorization :: Lens' Experimental (Maybe AuthorizationConfig) Source #
Authorization configuration.
Backend
`Backend` defines the backend configuration for a service.
See: backend
smart constructor.
Instances
Eq Backend Source # | |
Data Backend Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Backend -> c Backend # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Backend # toConstr :: Backend -> Constr # dataTypeOf :: Backend -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Backend) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Backend) # gmapT :: (forall b. Data b => b -> b) -> Backend -> Backend # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Backend -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Backend -> r # gmapQ :: (forall d. Data d => d -> u) -> Backend -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Backend -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Backend -> m Backend # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Backend -> m Backend # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Backend -> m Backend # | |
Show Backend Source # | |
Generic Backend Source # | |
ToJSON Backend Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Backend Source # | |
type Rep Backend Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Backend = D1 (MetaData "Backend" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" True) (C1 (MetaCons "Backend'" PrefixI True) (S1 (MetaSel (Just "_bRules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [BackendRule])))) |
bRules :: Lens' Backend [BackendRule] Source #
A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
Monitoring
data Monitoring Source #
Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count
See: monitoring
smart constructor.
Instances
monitoring :: Monitoring Source #
Creates a value of Monitoring
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mProducerDestinations :: Lens' Monitoring [MonitoringDestination] Source #
Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A metric can be used in at most one producer destination.
mConsumerDestinations :: Lens' Monitoring [MonitoringDestination] Source #
Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
LogDescriptor
data LogDescriptor Source #
A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer
See: logDescriptor
smart constructor.
Instances
logDescriptor :: LogDescriptor Source #
Creates a value of LogDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldName :: Lens' LogDescriptor (Maybe Text) Source #
The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
ldDisplayName :: Lens' LogDescriptor (Maybe Text) Source #
The human-readable name for this log. This information appears on the user interface and should be concise.
ldLabels :: Lens' LogDescriptor [LabelDescriptor] Source #
The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
ldDescription :: Lens' LogDescriptor (Maybe Text) Source #
A human-readable description of this log. This information appears in the documentation and can contain details.
Method
Method represents a method of an API interface.
See: method
smart constructor.
Instances
Creates a value of Method
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SystemParameters
data SystemParameters Source #
### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.
See: systemParameters
smart constructor.
Instances
systemParameters :: SystemParameters Source #
Creates a value of SystemParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spRules :: Lens' SystemParameters [SystemParameterRule] Source #
Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
Documentation
data Documentation Source #
`Documentation` provides the information for describing a service. Example:
documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ...
Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used:
[fully.qualified.proto.name][]
To override the display text used for the link, this can be used:
[display text][fully.qualified.proto.name]
Text can be excluded from doc using the following notation:
(-- internal comment --)
A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source:
(== include path/to/file ==)
The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection:
(== resource_for v1.shelves.books ==)
The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.
See: documentation
smart constructor.
Instances
documentation :: Documentation Source #
Creates a value of Documentation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dSummary :: Lens' Documentation (Maybe Text) Source #
A short summary of what the service does. Can only be provided by plain text.
dDocumentationRootURL :: Lens' Documentation (Maybe Text) Source #
The URL to the root of documentation.
dRules :: Lens' Documentation [DocumentationRule] Source #
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
dOverview :: Lens' Documentation (Maybe Text) Source #
Declares a single overview page. For example:
documentation: summary: ... overview: (== include overview.md ==)
This is a shortcut for the following declaration (using pages style):
documentation: summary: ... pages: - name: Overview content: (== include overview.md ==)
Note: you cannot specify both `overview` field and `pages` field.
Step
Represents the status of one operation step.
See: step
smart constructor.
Instances
Eq Step Source # | |
Data Step Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Step -> c Step # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Step # dataTypeOf :: Step -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Step) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Step) # gmapT :: (forall b. Data b => b -> b) -> Step -> Step # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Step -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Step -> r # gmapQ :: (forall d. Data d => d -> u) -> Step -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Step -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Step -> m Step # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Step -> m Step # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Step -> m Step # | |
Show Step Source # | |
Generic Step Source # | |
ToJSON Step Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Step Source # | |
type Rep Step Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Step = D1 (MetaData "Step" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Step'" PrefixI True) (S1 (MetaSel (Just "_sStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StepStatus)) :*: S1 (MetaSel (Just "_sDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
Creates a value of Step
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Xgafv
V1 error format.
Instances
MetricDescriptorMetadata
data MetricDescriptorMetadata Source #
Additional annotations that can be used to guide the usage of a metric.
See: metricDescriptorMetadata
smart constructor.
Instances
metricDescriptorMetadata :: MetricDescriptorMetadata Source #
Creates a value of MetricDescriptorMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdmSamplePeriod :: Lens' MetricDescriptorMetadata (Maybe Scientific) Source #
The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
mdmIngestDelay :: Lens' MetricDescriptorMetadata (Maybe Scientific) Source #
The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
mdmLaunchStage :: Lens' MetricDescriptorMetadata (Maybe MetricDescriptorMetadataLaunchStage) Source #
The launch stage of the metric definition.
SystemParameterRule
data SystemParameterRule Source #
Define a system parameter rule mapping system parameter definitions to methods.
See: systemParameterRule
smart constructor.
Instances
systemParameterRule :: SystemParameterRule Source #
Creates a value of SystemParameterRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sprSelector :: Lens' SystemParameterRule (Maybe Text) Source #
Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
sprParameters :: Lens' SystemParameterRule [SystemParameter] Source #
Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
LabelDescriptor
data LabelDescriptor Source #
A description of a label.
See: labelDescriptor
smart constructor.
Instances
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:
lValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType) Source #
The type of data that can be assigned to the label.
lDescription :: Lens' LabelDescriptor (Maybe Text) Source #
A human-readable description for the label.
Usage
Configuration controlling usage of a service.
See: usage
smart constructor.
Instances
Eq Usage Source # | |
Data Usage Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Usage -> c Usage # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Usage # dataTypeOf :: Usage -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Usage) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Usage) # gmapT :: (forall b. Data b => b -> b) -> Usage -> Usage # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Usage -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Usage -> r # gmapQ :: (forall d. Data d => d -> u) -> Usage -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Usage -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Usage -> m Usage # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Usage -> m Usage # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Usage -> m Usage # | |
Show Usage Source # | |
Generic Usage Source # | |
ToJSON Usage Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Usage Source # | |
type Rep Usage Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Usage = D1 (MetaData "Usage" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Usage'" PrefixI True) (S1 (MetaSel (Just "_uRequirements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_uRules") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsageRule])) :*: S1 (MetaSel (Just "_uProducerNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
Creates a value of Usage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uRequirements :: Lens' Usage [Text] Source #
Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.
uRules :: Lens' Usage [UsageRule] Source #
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
uProducerNotificationChannel :: Lens' Usage (Maybe Text) Source #
The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
FieldCardinality
data FieldCardinality Source #
The field cardinality.
CardinalityUnknown |
|
CardinalityOptional |
|
CardinalityRequired |
|
CardinalityRepeated |
|
Instances
HTTP
Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
See: hTTP
smart constructor.
Instances
Eq HTTP Source # | |
Data HTTP Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HTTP -> c HTTP # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HTTP # dataTypeOf :: HTTP -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HTTP) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HTTP) # gmapT :: (forall b. Data b => b -> b) -> HTTP -> HTTP # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HTTP -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HTTP -> r # gmapQ :: (forall d. Data d => d -> u) -> HTTP -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> HTTP -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> HTTP -> m HTTP # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HTTP -> m HTTP # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HTTP -> m HTTP # | |
Show HTTP Source # | |
Generic HTTP Source # | |
ToJSON HTTP Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON HTTP Source # | |
type Rep HTTP Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep HTTP = D1 (MetaData "HTTP" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "HTTP'" PrefixI True) (S1 (MetaSel (Just "_hRules") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [HTTPRule])) :*: S1 (MetaSel (Just "_hFullyDecodeReservedExpansion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) |
Creates a value of HTTP
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hRules :: Lens' HTTP [HTTPRule] Source #
A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
hFullyDecodeReservedExpansion :: Lens' HTTP (Maybe Bool) Source #
When set to true, URL path parmeters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
DisableServiceRequest
data DisableServiceRequest Source #
Request message for DisableService method.
See: disableServiceRequest
smart constructor.
Instances
disableServiceRequest :: DisableServiceRequest Source #
Creates a value of DisableServiceRequest
with the minimum fields required to make a request.
Type
A protocol buffer message type.
See: type'
smart constructor.
Instances
Eq Type Source # | |
Data Type Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Type -> c Type # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Type # dataTypeOf :: Type -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Type) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Type) # gmapT :: (forall b. Data b => b -> b) -> Type -> Type # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQ :: (forall d. Data d => d -> u) -> Type -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Type -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # | |
Show Type Source # | |
Generic Type Source # | |
ToJSON Type Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Type Source # | |
type Rep Type Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Type = D1 (MetaData "Type" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Type'" PrefixI True) ((S1 (MetaSel (Just "_tSourceContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceContext)) :*: (S1 (MetaSel (Just "_tOneofs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_tName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_tOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Option])) :*: (S1 (MetaSel (Just "_tFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Field])) :*: S1 (MetaSel (Just "_tSyntax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TypeSyntax)))))) |
tSourceContext :: Lens' Type (Maybe SourceContext) Source #
The source context.
tOneofs :: Lens' Type [Text] Source #
The list of types appearing in `oneof` definitions in this type.
API
Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.
See: api
smart constructor.
Instances
Eq API Source # | |
Data API Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> API -> c API # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c API # dataTypeOf :: API -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c API) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c API) # gmapT :: (forall b. Data b => b -> b) -> API -> API # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> API -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> API -> r # gmapQ :: (forall d. Data d => d -> u) -> API -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> API -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> API -> m API # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> API -> m API # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> API -> m API # | |
Show API Source # | |
Generic API Source # | |
ToJSON API Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON API Source # | |
type Rep API Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep API = D1 (MetaData "API" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "API'" PrefixI True) ((S1 (MetaSel (Just "_aSourceContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceContext)) :*: (S1 (MetaSel (Just "_aMixins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Mixin])) :*: S1 (MetaSel (Just "_aMethods") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Method])))) :*: ((S1 (MetaSel (Just "_aName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_aVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_aOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Option])) :*: S1 (MetaSel (Just "_aSyntax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe APISyntax)))))) |
aSourceContext :: Lens' API (Maybe SourceContext) Source #
Source context for the protocol buffer service represented by this message.
aName :: Lens' API (Maybe Text) Source #
The fully qualified name of this interface, including package name followed by the interface's simple name.
aVersion :: Lens' API (Maybe Text) Source #
A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
MonitoringDestination
data MonitoringDestination Source #
Configuration of a specific monitoring destination (the producer project or the consumer project).
See: monitoringDestination
smart constructor.
Instances
monitoringDestination :: MonitoringDestination Source #
Creates a value of MonitoringDestination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdMetrics :: Lens' MonitoringDestination [Text] Source #
Names of the metrics to report to this monitoring destination. Each name must be defined in Service.metrics section.
mdMonitoredResource :: Lens' MonitoringDestination (Maybe Text) Source #
The monitored resource type. The type must be defined in Service.monitored_resources section.
OperationMetadata
data OperationMetadata Source #
The metadata associated with a long running operation resource.
See: operationMetadata
smart constructor.
Instances
operationMetadata :: OperationMetadata Source #
Creates a value of OperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omStartTime :: Lens' OperationMetadata (Maybe UTCTime) Source #
The start time of the operation.
omSteps :: Lens' OperationMetadata [Step] Source #
Detailed status information for each step. The order is undetermined.
omProgressPercentage :: Lens' OperationMetadata (Maybe Int32) Source #
Percentage of completion of this operation, ranging from 0 to 100.
omResourceNames :: Lens' OperationMetadata [Text] Source #
The full name of the resources that this operation is directly associated with.
Endpoint
`Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true
See: endpoint
smart constructor.
Instances
eAliases :: Lens' Endpoint [Text] Source #
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
eAllowCORS :: Lens' Endpoint (Maybe Bool) Source #
Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
eTarget :: Lens' Endpoint (Maybe Text) Source #
The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
OAuthRequirements
data OAuthRequirements Source #
OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.
See: oAuthRequirements
smart constructor.
Instances
oAuthRequirements :: OAuthRequirements Source #
Creates a value of OAuthRequirements
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oarCanonicalScopes :: Lens' OAuthRequirements (Maybe Text) Source #
The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
MetricDescriptorMetricKind
data MetricDescriptorMetricKind Source #
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
MetricKindUnspecified |
|
Gauge |
|
Delta |
|
Cumulative |
|
Instances
CustomError
data CustomError Source #
Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
See: customError
smart constructor.
Instances
customError :: CustomError Source #
Creates a value of CustomError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ceRules :: Lens' CustomError [CustomErrorRule] Source #
The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.
ceTypes :: Lens' CustomError [Text] Source #
The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
QuotaLimit
data QuotaLimit Source #
`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.
See: quotaLimit
smart constructor.
Instances
quotaLimit :: QuotaLimit Source #
Creates a value of QuotaLimit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qlValues :: Lens' QuotaLimit (Maybe QuotaLimitValues) Source #
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
qlFreeTier :: Lens' QuotaLimit (Maybe Int64) Source #
Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
qlMetric :: Lens' QuotaLimit (Maybe Text) Source #
The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
qlName :: Lens' QuotaLimit (Maybe Text) Source #
Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
qlDisplayName :: Lens' QuotaLimit (Maybe Text) Source #
User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
qlDuration :: Lens' QuotaLimit (Maybe Text) Source #
Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only.
qlDefaultLimit :: Lens' QuotaLimit (Maybe Int64) Source #
Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
qlDescription :: Lens' QuotaLimit (Maybe Text) Source #
Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
qlUnit :: Lens' QuotaLimit (Maybe Text) Source #
Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
qlMaxLimit :: Lens' QuotaLimit (Maybe Int64) Source #
Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
See: option
smart constructor.
Instances
Eq Option Source # | |
Data Option Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Option -> c Option # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Option # toConstr :: Option -> Constr # dataTypeOf :: Option -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Option) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Option) # gmapT :: (forall b. Data b => b -> b) -> Option -> Option # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Option -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Option -> r # gmapQ :: (forall d. Data d => d -> u) -> Option -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Option -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Option -> m Option # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Option -> m Option # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Option -> m Option # | |
Show Option Source # | |
Generic Option Source # | |
ToJSON Option Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Option Source # | |
type Rep Option Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Option = D1 (MetaData "Option" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Option'" PrefixI True) (S1 (MetaSel (Just "_optValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OptionValue)) :*: S1 (MetaSel (Just "_optName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
optValue :: Lens' Option (Maybe OptionValue) Source #
The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
optName :: Lens' Option (Maybe Text) Source #
The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.
Billing
Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count
See: billing
smart constructor.
Instances
Eq Billing Source # | |
Data Billing Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Billing -> c Billing # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Billing # toConstr :: Billing -> Constr # dataTypeOf :: Billing -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Billing) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Billing) # gmapT :: (forall b. Data b => b -> b) -> Billing -> Billing # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Billing -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Billing -> r # gmapQ :: (forall d. Data d => d -> u) -> Billing -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Billing -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Billing -> m Billing # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Billing -> m Billing # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Billing -> m Billing # | |
Show Billing Source # | |
Generic Billing Source # | |
ToJSON Billing Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Billing Source # | |
type Rep Billing Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Billing = D1 (MetaData "Billing" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" True) (C1 (MetaCons "Billing'" PrefixI True) (S1 (MetaSel (Just "_bConsumerDestinations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [BillingDestination])))) |
Creates a value of Billing
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bConsumerDestinations :: Lens' Billing [BillingDestination] Source #
Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
SourceInfo
data SourceInfo Source #
Source information used to create a Service Config
See: sourceInfo
smart constructor.
Instances
sourceInfo :: SourceInfo Source #
Creates a value of SourceInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siSourceFiles :: Lens' SourceInfo [SourceInfoSourceFilesItem] Source #
All files used during config generation.
QuotaLimitValues
data QuotaLimitValues Source #
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
See: quotaLimitValues
smart constructor.
Instances
Creates a value of QuotaLimitValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Enum'
Enum type definition.
See: enum
smart constructor.
Instances
Eq Enum' Source # | |
Data Enum' Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Enum' -> c Enum' # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Enum' # dataTypeOf :: Enum' -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Enum') # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Enum') # gmapT :: (forall b. Data b => b -> b) -> Enum' -> Enum' # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Enum' -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Enum' -> r # gmapQ :: (forall d. Data d => d -> u) -> Enum' -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Enum' -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Enum' -> m Enum' # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Enum' -> m Enum' # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Enum' -> m Enum' # | |
Show Enum' Source # | |
Generic Enum' Source # | |
ToJSON Enum' Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Enum' Source # | |
type Rep Enum' Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Enum' = D1 (MetaData "Enum'" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Enum''" PrefixI True) ((S1 (MetaSel (Just "_enuSourceContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceContext)) :*: S1 (MetaSel (Just "_enuEnumvalue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnumValue]))) :*: (S1 (MetaSel (Just "_enuName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_enuOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Option])) :*: S1 (MetaSel (Just "_enuSyntax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnumSyntax)))))) |
Creates a value of Enum
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
enuSourceContext :: Lens' Enum' (Maybe SourceContext) Source #
The source context.
Logging
Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history
See: logging
smart constructor.
Instances
Eq Logging Source # | |
Data Logging Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Logging -> c Logging # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Logging # toConstr :: Logging -> Constr # dataTypeOf :: Logging -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Logging) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Logging) # gmapT :: (forall b. Data b => b -> b) -> Logging -> Logging # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Logging -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Logging -> r # gmapQ :: (forall d. Data d => d -> u) -> Logging -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Logging -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Logging -> m Logging # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Logging -> m Logging # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Logging -> m Logging # | |
Show Logging Source # | |
Generic Logging Source # | |
ToJSON Logging Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Logging Source # | |
type Rep Logging Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Logging = D1 (MetaData "Logging" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Logging'" PrefixI True) (S1 (MetaSel (Just "_lProducerDestinations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LoggingDestination])) :*: S1 (MetaSel (Just "_lConsumerDestinations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LoggingDestination])))) |
Creates a value of Logging
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lProducerDestinations :: Lens' Logging [LoggingDestination] Source #
Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
lConsumerDestinations :: Lens' Logging [LoggingDestination] Source #
Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
MethodSyntax
data MethodSyntax Source #
The source syntax of this method.
MSSyntaxPROTO2 |
|
MSSyntaxPROTO3 |
|
Instances
SourceInfoSourceFilesItem
data SourceInfoSourceFilesItem Source #
Instances
sourceInfoSourceFilesItem Source #
Creates a value of SourceInfoSourceFilesItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sisfiAddtional :: Lens' SourceInfoSourceFilesItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
Quota
Quota configuration helps to achieve fairness and budgeting in service usage. The quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
See: quota
smart constructor.
Instances
Eq Quota Source # | |
Data Quota Source # | |
Defined in Network.Google.ServiceUser.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Quota -> c Quota # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Quota # dataTypeOf :: Quota -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Quota) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Quota) # gmapT :: (forall b. Data b => b -> b) -> Quota -> Quota # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Quota -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Quota -> r # gmapQ :: (forall d. Data d => d -> u) -> Quota -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Quota -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Quota -> m Quota # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Quota -> m Quota # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Quota -> m Quota # | |
Show Quota Source # | |
Generic Quota Source # | |
ToJSON Quota Source # | |
Defined in Network.Google.ServiceUser.Types.Product | |
FromJSON Quota Source # | |
type Rep Quota Source # | |
Defined in Network.Google.ServiceUser.Types.Product type Rep Quota = D1 (MetaData "Quota" "Network.Google.ServiceUser.Types.Product" "gogol-serviceuser-0.4.0-vbyOky5CodDiKr3KpDP56" False) (C1 (MetaCons "Quota'" PrefixI True) (S1 (MetaSel (Just "_qLimits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [QuotaLimit])) :*: S1 (MetaSel (Just "_qMetricRules") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricRule])))) |
Creates a value of Quota
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qMetricRules :: Lens' Quota [MetricRule] Source #
List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
HTTPRule
# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including Google APIs, Cloud Endpoints, gRPC Gateway, and Envoy proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the Discovery Document as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the Discovery Document as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the proto3 specification. While the single segment variable follows the semantics of RFC 6570 Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.
See: hTTPRule
smart constructor.
Instances
Creates a value of HTTPRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httprSelector :: Lens' HTTPRule (Maybe Text) Source #
Selects a method to which this rule applies. Refer to selector for syntax details.
httprPost :: Lens' HTTPRule (Maybe Text) Source #
Maps to HTTP POST. Used for creating a resource or performing an action.
httprBody :: Lens' HTTPRule (Maybe Text) Source #
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
httprCustom :: Lens' HTTPRule (Maybe CustomHTTPPattern) Source #
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
httprResponseBody :: Lens' HTTPRule (Maybe Text) Source #
Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
httprGet :: Lens' HTTPRule (Maybe Text) Source #
Maps to HTTP GET. Used for listing and getting information about resources.
httprAdditionalBindings :: Lens' HTTPRule [HTTPRule] Source #
Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
httprDelete :: Lens' HTTPRule (Maybe Text) Source #
Maps to HTTP DELETE. Used for deleting a resource.
OperationResponse
data OperationResponse Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
See: operationResponse
smart constructor.
Instances
Creates a value of OperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
AuthProvider
data AuthProvider Source #
Configuration for an anthentication provider, including support for JSON Web Token (JWT).
See: authProvider
smart constructor.
Instances
authProvider :: AuthProvider Source #
Creates a value of AuthProvider
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apJWKsURI :: Lens' AuthProvider (Maybe Text) Source #
URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
apAudiences :: Lens' AuthProvider (Maybe Text) Source #
The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
apId :: Lens' AuthProvider (Maybe Text) Source #
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
apAuthorizationURL :: Lens' AuthProvider (Maybe Text) Source #
Redirect URL if JWT token is required but no present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
apIssuer :: Lens' AuthProvider (Maybe Text) Source #
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute'developer.gserviceaccount.com
ContextRule
data ContextRule Source #
A context rule provides information about the context for an individual API element.
See: contextRule
smart constructor.
Instances
contextRule :: ContextRule Source #
Creates a value of ContextRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crSelector :: Lens' ContextRule (Maybe Text) Source #
Selects the methods to which this rule applies. Refer to selector for syntax details.
crRequested :: Lens' ContextRule [Text] Source #
A list of full type names of requested contexts.
crAllowedRequestExtensions :: Lens' ContextRule [Text] Source #
A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
crProvided :: Lens' ContextRule [Text] Source #
A list of full type names of provided contexts.
crAllowedResponseExtensions :: Lens' ContextRule [Text] Source #
A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.