Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- servicenetworking.operations.cancel
- servicenetworking.operations.delete
- servicenetworking.operations.get
- servicenetworking.operations.list
- servicenetworking.services.addSubnetwork
- servicenetworking.services.connections.create
- servicenetworking.services.connections.list
- servicenetworking.services.connections.patch
- servicenetworking.services.searchRange
- Types
- GoogleCloudServicenetworkingV1betaSubnetwork
- MetricDescriptorValueType
- SystemParameter
- MonitoredResourceDescriptor
- BackendRulePathTranslation
- ListConnectionsResponse
- DocumentationRule
- Status
- BillingDestination
- Control
- AuthRequirement
- Context
- LoggingDestination
- MetricDescriptor
- ListOperationsResponse
- CancelOperationRequest
- BackendRule
- SourceContext
- Field
- MetricRule
- FieldKind
- EnumSyntax
- Service
- Operation
- Empty
- CustomErrorRule
- OptionValue
- EnumValue
- Authentication
- MetricDescriptorMetadataLaunchStage
- Mixin
- CustomHTTPPattern
- UsageRule
- StatusDetailsItem
- Page
- AuthenticationRule
- Connection
- LabelDescriptorValueType
- MetricRuleMetricCosts
- AuthorizationConfig
- APISyntax
- TypeSyntax
- Experimental
- Backend
- Monitoring
- LogDescriptor
- Method
- Range
- SystemParameters
- Documentation
- Xgafv
- MetricDescriptorMetadata
- Subnetwork
- AddSubnetworkRequest
- SystemParameterRule
- LabelDescriptor
- Usage
- FieldCardinality
- SearchRangeRequest
- HTTP
- Type
- API
- MonitoringDestination
- OperationMetadata
- Endpoint
- OAuthRequirements
- MetricDescriptorMetricKind
- CustomError
- QuotaLimit
- Option
- Billing
- SourceInfo
- QuotaLimitValues
- Enum'
- Logging
- MethodSyntax
- SourceInfoSourceFilesItem
- Quota
- HTTPRule
- OperationResponse
- AuthProvider
- ContextRule
Provides automatic management of network configurations necessary for certain services.
Synopsis
- serviceNetworkingService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- serviceManagementScope :: Proxy '["https://www.googleapis.com/auth/service.management"]
- type ServiceNetworkingAPI = OperationsListResource :<|> (OperationsGetResource :<|> (OperationsCancelResource :<|> (OperationsDeleteResource :<|> (ServicesConnectionsListResource :<|> (ServicesConnectionsPatchResource :<|> (ServicesConnectionsCreateResource :<|> (ServicesAddSubnetworkResource :<|> ServicesSearchRangeResource)))))))
- module Network.Google.Resource.ServiceNetworking.Operations.Cancel
- module Network.Google.Resource.ServiceNetworking.Operations.Delete
- module Network.Google.Resource.ServiceNetworking.Operations.Get
- module Network.Google.Resource.ServiceNetworking.Operations.List
- module Network.Google.Resource.ServiceNetworking.Services.AddSubnetwork
- module Network.Google.Resource.ServiceNetworking.Services.Connections.Create
- module Network.Google.Resource.ServiceNetworking.Services.Connections.List
- module Network.Google.Resource.ServiceNetworking.Services.Connections.Patch
- module Network.Google.Resource.ServiceNetworking.Services.SearchRange
- data GoogleCloudServicenetworkingV1betaSubnetwork
- googleCloudServicenetworkingV1betaSubnetwork :: GoogleCloudServicenetworkingV1betaSubnetwork
- gcsvsOutsideAllocation :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Bool)
- gcsvsNetwork :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text)
- gcsvsName :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text)
- gcsvsIPCIdRRange :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text)
- 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 BackendRulePathTranslation
- data ListConnectionsResponse
- listConnectionsResponse :: ListConnectionsResponse
- lcrConnections :: Lens' ListConnectionsResponse [Connection]
- 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 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 ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data CancelOperationRequest
- cancelOperationRequest :: CancelOperationRequest
- data BackendRule
- backendRule :: BackendRule
- brJwtAudience :: Lens' BackendRule (Maybe Text)
- brSelector :: Lens' BackendRule (Maybe Text)
- brMinDeadline :: Lens' BackendRule (Maybe Double)
- brAddress :: Lens' BackendRule (Maybe Text)
- brOperationDeadline :: Lens' BackendRule (Maybe Double)
- brDeadline :: Lens' BackendRule (Maybe Double)
- brPathTranslation :: Lens' BackendRule (Maybe BackendRulePathTranslation)
- data SourceContext
- sourceContext :: SourceContext
- scFileName :: Lens' SourceContext (Maybe Text)
- 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 OperationMetadata)
- data Empty
- empty :: Empty
- 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 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 Connection
- connection :: Connection
- cPeering :: Lens' Connection (Maybe Text)
- cReservedPeeringRanges :: Lens' Connection [Text]
- cService :: Lens' Connection (Maybe Text)
- cNetwork :: Lens' Connection (Maybe Text)
- 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 Range
- range :: Range
- rNetwork :: Lens' Range (Maybe Text)
- rIPCIdRRange :: Lens' Range (Maybe Text)
- 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 Xgafv
- data MetricDescriptorMetadata
- metricDescriptorMetadata :: MetricDescriptorMetadata
- mdmSamplePeriod :: Lens' MetricDescriptorMetadata (Maybe Scientific)
- mdmIngestDelay :: Lens' MetricDescriptorMetadata (Maybe Scientific)
- mdmLaunchStage :: Lens' MetricDescriptorMetadata (Maybe MetricDescriptorMetadataLaunchStage)
- data Subnetwork
- subnetwork :: Subnetwork
- subOutsideAllocation :: Lens' Subnetwork (Maybe Bool)
- subNetwork :: Lens' Subnetwork (Maybe Text)
- subName :: Lens' Subnetwork (Maybe Text)
- subIPCIdRRange :: Lens' Subnetwork (Maybe Text)
- data AddSubnetworkRequest
- addSubnetworkRequest :: AddSubnetworkRequest
- asrIPPrefixLength :: Lens' AddSubnetworkRequest (Maybe Int32)
- asrRequestedAddress :: Lens' AddSubnetworkRequest (Maybe Text)
- asrSubnetwork :: Lens' AddSubnetworkRequest (Maybe Text)
- asrRegion :: Lens' AddSubnetworkRequest (Maybe Text)
- asrSubnetworkUsers :: Lens' AddSubnetworkRequest [Text]
- asrConsumerNetwork :: Lens' AddSubnetworkRequest (Maybe Text)
- asrConsumer :: Lens' AddSubnetworkRequest (Maybe Text)
- asrDescription :: Lens' AddSubnetworkRequest (Maybe Text)
- 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 SearchRangeRequest
- searchRangeRequest :: SearchRangeRequest
- srrIPPrefixLength :: Lens' SearchRangeRequest (Maybe Int32)
- srrNetwork :: Lens' SearchRangeRequest (Maybe Text)
- data HTTP
- hTTP :: HTTP
- hRules :: Lens' HTTP [HTTPRule]
- hFullyDecodeReservedExpansion :: Lens' HTTP (Maybe Bool)
- 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 :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- 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
serviceNetworkingService :: ServiceConfig Source #
Default request referring to version v1
of the Service Networking API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
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
API Declaration
type ServiceNetworkingAPI = OperationsListResource :<|> (OperationsGetResource :<|> (OperationsCancelResource :<|> (OperationsDeleteResource :<|> (ServicesConnectionsListResource :<|> (ServicesConnectionsPatchResource :<|> (ServicesConnectionsCreateResource :<|> (ServicesAddSubnetworkResource :<|> ServicesSearchRangeResource))))))) Source #
Represents the entirety of the methods and resources available for the Service Networking API service.
Resources
servicenetworking.operations.cancel
servicenetworking.operations.delete
servicenetworking.operations.get
servicenetworking.operations.list
servicenetworking.services.addSubnetwork
servicenetworking.services.connections.create
servicenetworking.services.connections.list
servicenetworking.services.connections.patch
servicenetworking.services.searchRange
Types
GoogleCloudServicenetworkingV1betaSubnetwork
data GoogleCloudServicenetworkingV1betaSubnetwork Source #
Represents a subnet that was created or discovered by a private access management service.
See: googleCloudServicenetworkingV1betaSubnetwork
smart constructor.
Instances
googleCloudServicenetworkingV1betaSubnetwork :: GoogleCloudServicenetworkingV1betaSubnetwork Source #
Creates a value of GoogleCloudServicenetworkingV1betaSubnetwork
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcsvsOutsideAllocation :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Bool) Source #
This is a discovered subnet that is not within the current consumer allocated ranges.
gcsvsNetwork :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text) Source #
In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network`
gcsvsName :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text) Source #
Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
gcsvsIPCIdRRange :: Lens' GoogleCloudServicenetworkingV1betaSubnetwork (Maybe Text) Source #
Subnetwork CIDR range in `10.x.x.x/y` format.
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.
BackendRulePathTranslation
data BackendRulePathTranslation Source #
PathTranslationUnspecified | PATH_TRANSLATION_UNSPECIFIED |
ConstantAddress |
|
AppendPathToAddress |
|
Instances
ListConnectionsResponse
data ListConnectionsResponse Source #
ListConnectionsResponse is the response to list peering states for the given service and consumer project.
See: listConnectionsResponse
smart constructor.
Instances
listConnectionsResponse :: ListConnectionsResponse Source #
Creates a value of ListConnectionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrConnections :: Lens' ListConnectionsResponse [Connection] Source #
The list of Connections.
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". A wildcard will match one or more components. 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.ServiceNetworking.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 # | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.ServiceNetworking.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.ServiceNetworking.Types.Product" "gogol-servicenetworking-0.5.0-8ZYyNJVUNnRE5WvJBnqzZ8" 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.
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.ServiceNetworking.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 # | |
FromJSON Control Source # | |
type Rep Control Source # | |
Defined in Network.Google.ServiceNetworking.Types.Product type Rep Control = D1 (MetaData "Control" "Network.Google.ServiceNetworking.Types.Product" "gogol-servicenetworking-0.5.0-8ZYyNJVUNnRE5WvJBnqzZ8" True) (C1 (MetaCons "Control'" PrefixI True) (S1 (MetaSel (Just "_cEnvironment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) |
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.ServiceNetworking.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 # | |
FromJSON Context Source # | |
type Rep Context Source # | |
Defined in Network.Google.ServiceNetworking.Types.Product type Rep Context = D1 (MetaData "Context" "Network.Google.ServiceNetworking.Types.Product" "gogol-servicenetworking-0.5.0-8ZYyNJVUNnRE5WvJBnqzZ8" 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.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for Operations.ListOperations.
See: listOperationsResponse
smart constructor.
Instances
listOperationsResponse :: ListOperationsResponse Source #
Creates a value of ListOperationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
lorOperations :: Lens' ListOperationsResponse [Operation] Source #
A list of operations that matches the specified filter in the request.
CancelOperationRequest
data CancelOperationRequest Source #
The request message for Operations.CancelOperation.
See: cancelOperationRequest
smart constructor.
Instances
cancelOperationRequest :: CancelOperationRequest Source #
Creates a value of CancelOperationRequest
with the minimum fields required to make a request.
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:
brJwtAudience :: Lens' BackendRule (Maybe Text) Source #
The JWT audience is used when generating a JWT id token for the backend.
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.
brOperationDeadline :: Lens' BackendRule (Maybe Double) Source #
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
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"`.
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 service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.
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 OperationMetadata) 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.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.ServiceNetworking.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
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.