Network.Google.Discovery.Types

Service Configuration

discoveryService :: Service

Default request referring to version v1 of the APIs Discovery Service. This contains the host and root path used as a starting point for constructing service requests.

RestMethodResponse

data RestMethodResponse

The schema for the response.

See: restMethodResponse smart constructor.

Instances

Eq RestMethodResponse

Data RestMethodResponse

Show RestMethodResponse

Generic RestMethodResponse

ToJSON RestMethodResponse

FromJSON RestMethodResponse

type Rep RestMethodResponse

restMethodResponse :: RestMethodResponse

Creates a value of RestMethodResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmrRef

rmrRef :: Lens' RestMethodResponse (Maybe Text)

Schema ID for the response schema.

RestDescriptionParameters

data RestDescriptionParameters

Common parameters that apply across all apis.

See: restDescriptionParameters smart constructor.

Instances

Eq RestDescriptionParameters

Data RestDescriptionParameters

Show RestDescriptionParameters

Generic RestDescriptionParameters

ToJSON RestDescriptionParameters

FromJSON RestDescriptionParameters

type Rep RestDescriptionParameters

restDescriptionParameters

Arguments

:: HashMap Text JSONSchema

rdpAddtional

-> RestDescriptionParameters

Creates a value of RestDescriptionParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdpAddtional

rdpAddtional :: Lens' RestDescriptionParameters (HashMap Text JSONSchema)

Description of a single parameter.

RestMethod

data RestMethod

Instances

Eq RestMethod

Data RestMethod

Show RestMethod

Generic RestMethod

ToJSON RestMethod

FromJSON RestMethod

type Rep RestMethod

restMethod :: RestMethod

Creates a value of RestMethod with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmSupportsMediaDownload
• rmParameterOrder
• rmMediaUpload
• rmHTTPMethod
• rmPath
• rmResponse
• rmSupportsMediaUpload
• rmScopes
• rmSupportsSubscription
• rmParameters
• rmId
• rmEtagRequired
• rmUseMediaDownloadService
• rmDescription
• rmRequest

rmSupportsMediaDownload :: Lens' RestMethod (Maybe Bool)

Whether this method supports media downloads.

rmParameterOrder :: Lens' RestMethod [Text]

Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.

rmMediaUpload :: Lens' RestMethod (Maybe RestMethodMediaUpload)

Media upload parameters.

rmHTTPMethod :: Lens' RestMethod (Maybe Text)

HTTP method used by this method.

rmPath :: Lens' RestMethod (Maybe Text)

The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

rmResponse :: Lens' RestMethod (Maybe RestMethodResponse)

The schema for the response.

rmSupportsMediaUpload :: Lens' RestMethod (Maybe Bool)

Whether this method supports media uploads.

rmScopes :: Lens' RestMethod [Text]

OAuth 2.0 scopes applicable to this method.

rmSupportsSubscription :: Lens' RestMethod (Maybe Bool)

Whether this method supports subscriptions.

rmParameters :: Lens' RestMethod (Maybe RestMethodParameters)

Details for all parameters in this method.

rmId :: Lens' RestMethod (Maybe Text)

A unique ID for this method. This property can be used to match methods between different versions of Discovery.

rmEtagRequired :: Lens' RestMethod (Maybe Bool)

Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

rmUseMediaDownloadService :: Lens' RestMethod (Maybe Bool)

Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

rmDescription :: Lens' RestMethod (Maybe Text)

Description of this method.

rmRequest :: Lens' RestMethod (Maybe RestMethodRequest)

The schema for the request.

RestResource

data RestResource

Instances

Eq RestResource

Data RestResource

Show RestResource

Generic RestResource

ToJSON RestResource

FromJSON RestResource

type Rep RestResource

restResource :: RestResource

Creates a value of RestResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrResources
• rrMethods

rrResources :: Lens' RestResource (Maybe RestResourceResources)

Sub-resources on this resource.

rrMethods :: Lens' RestResource (Maybe RestResourceMethods)

Methods on this resource.

RestDescriptionAuthOAuth2Scopes

data RestDescriptionAuthOAuth2Scopes

Available OAuth 2.0 scopes.

See: restDescriptionAuthOAuth2Scopes smart constructor.

Instances

Eq RestDescriptionAuthOAuth2Scopes

Data RestDescriptionAuthOAuth2Scopes

Show RestDescriptionAuthOAuth2Scopes

Generic RestDescriptionAuthOAuth2Scopes

ToJSON RestDescriptionAuthOAuth2Scopes

FromJSON RestDescriptionAuthOAuth2Scopes

type Rep RestDescriptionAuthOAuth2Scopes

restDescriptionAuthOAuth2Scopes

Arguments

:: HashMap Text RestDescriptionAuthOAuth2ScopesAdditional

rdaoasAddtional

-> RestDescriptionAuthOAuth2Scopes

Creates a value of RestDescriptionAuthOAuth2Scopes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoasAddtional

rdaoasAddtional :: Lens' RestDescriptionAuthOAuth2Scopes (HashMap Text RestDescriptionAuthOAuth2ScopesAdditional)

The scope value.

RestDescriptionMethods

data RestDescriptionMethods

API-level methods for this API.

See: restDescriptionMethods smart constructor.

Instances

Eq RestDescriptionMethods

Data RestDescriptionMethods

Show RestDescriptionMethods

Generic RestDescriptionMethods

ToJSON RestDescriptionMethods

FromJSON RestDescriptionMethods

type Rep RestDescriptionMethods

restDescriptionMethods

Arguments

:: HashMap Text RestMethod

rdmAddtional

-> RestDescriptionMethods

Creates a value of RestDescriptionMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdmAddtional

rdmAddtional :: Lens' RestDescriptionMethods (HashMap Text RestMethod)

An individual method description.

DirectoryListItemsItem

data DirectoryListItemsItem

Instances

Eq DirectoryListItemsItem

Data DirectoryListItemsItem

Show DirectoryListItemsItem

Generic DirectoryListItemsItem

ToJSON DirectoryListItemsItem

FromJSON DirectoryListItemsItem

type Rep DirectoryListItemsItem

directoryListItemsItem :: DirectoryListItemsItem

Creates a value of DirectoryListItemsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dliiDiscoveryLink
• dliiPreferred
• dliiKind
• dliiIcons
• dliiName
• dliiVersion
• dliiDocumentationLink
• dliiId
• dliiLabels
• dliiTitle
• dliiDescription
• dliiDiscoveryRestURL

dliiDiscoveryLink :: Lens' DirectoryListItemsItem (Maybe Text)

A link to the discovery document.

dliiPreferred :: Lens' DirectoryListItemsItem (Maybe Bool)

True if this version is the preferred version to use.

dliiKind :: Lens' DirectoryListItemsItem Text

The kind for this response.

dliiIcons :: Lens' DirectoryListItemsItem (Maybe DirectoryListItemsItemIcons)

Links to 16x16 and 32x32 icons representing the API.

dliiName :: Lens' DirectoryListItemsItem (Maybe Text)

The name of the API.

dliiVersion :: Lens' DirectoryListItemsItem (Maybe Text)

The version of the API.

dliiDocumentationLink :: Lens' DirectoryListItemsItem (Maybe Text)

A link to human readable documentation for the API.

dliiId :: Lens' DirectoryListItemsItem (Maybe Text)

The id of this API.

dliiLabels :: Lens' DirectoryListItemsItem [Text]

Labels for the status of this API, such as labs or deprecated.

dliiTitle :: Lens' DirectoryListItemsItem (Maybe Text)

The title of this API.

dliiDescription :: Lens' DirectoryListItemsItem (Maybe Text)

The description of this API.

dliiDiscoveryRestURL :: Lens' DirectoryListItemsItem (Maybe Text)

The URL for the discovery REST document.

DirectoryListItemsItemIcons

data DirectoryListItemsItemIcons

Links to 16x16 and 32x32 icons representing the API.

See: directoryListItemsItemIcons smart constructor.

Instances

Eq DirectoryListItemsItemIcons

Data DirectoryListItemsItemIcons

Show DirectoryListItemsItemIcons

Generic DirectoryListItemsItemIcons

ToJSON DirectoryListItemsItemIcons

FromJSON DirectoryListItemsItemIcons

type Rep DirectoryListItemsItemIcons

directoryListItemsItemIcons :: DirectoryListItemsItemIcons

Creates a value of DirectoryListItemsItemIcons with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dliiiX16
• dliiiX32

dliiiX16 :: Lens' DirectoryListItemsItemIcons (Maybe Text)

The URL of the 16x16 icon.

dliiiX32 :: Lens' DirectoryListItemsItemIcons (Maybe Text)

The URL of the 32x32 icon.

RestResourceResources

data RestResourceResources

Sub-resources on this resource.

See: restResourceResources smart constructor.

Instances

Eq RestResourceResources

Data RestResourceResources

Show RestResourceResources

Generic RestResourceResources

ToJSON RestResourceResources

FromJSON RestResourceResources

type Rep RestResourceResources

restResourceResources

Arguments

:: HashMap Text RestResource

rrrAddtional

-> RestResourceResources

Creates a value of RestResourceResources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrrAddtional

rrrAddtional :: Lens' RestResourceResources (HashMap Text RestResource)

Description for any sub-resources on this resource.

RestDescriptionAuthOAuth2

data RestDescriptionAuthOAuth2

OAuth 2.0 authentication information.

See: restDescriptionAuthOAuth2 smart constructor.

Instances

Eq RestDescriptionAuthOAuth2

Data RestDescriptionAuthOAuth2

Show RestDescriptionAuthOAuth2

Generic RestDescriptionAuthOAuth2

ToJSON RestDescriptionAuthOAuth2

FromJSON RestDescriptionAuthOAuth2

type Rep RestDescriptionAuthOAuth2

restDescriptionAuthOAuth2 :: RestDescriptionAuthOAuth2

Creates a value of RestDescriptionAuthOAuth2 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoaScopes

rdaoaScopes :: Lens' RestDescriptionAuthOAuth2 (Maybe RestDescriptionAuthOAuth2Scopes)

Available OAuth 2.0 scopes.

RestDescriptionAuthOAuth2ScopesAdditional

data RestDescriptionAuthOAuth2ScopesAdditional

The scope value.

See: restDescriptionAuthOAuth2ScopesAdditional smart constructor.

Instances

Eq RestDescriptionAuthOAuth2ScopesAdditional

Data RestDescriptionAuthOAuth2ScopesAdditional

Show RestDescriptionAuthOAuth2ScopesAdditional

Generic RestDescriptionAuthOAuth2ScopesAdditional

ToJSON RestDescriptionAuthOAuth2ScopesAdditional

FromJSON RestDescriptionAuthOAuth2ScopesAdditional

type Rep RestDescriptionAuthOAuth2ScopesAdditional

restDescriptionAuthOAuth2ScopesAdditional :: RestDescriptionAuthOAuth2ScopesAdditional

Creates a value of RestDescriptionAuthOAuth2ScopesAdditional with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaoasaDescription

rdaoasaDescription :: Lens' RestDescriptionAuthOAuth2ScopesAdditional (Maybe Text)

Description of scope.

RestMethodMediaUploadProtocolsSimple

data RestMethodMediaUploadProtocolsSimple

Supports uploading as a single HTTP request.

See: restMethodMediaUploadProtocolsSimple smart constructor.

Instances

Eq RestMethodMediaUploadProtocolsSimple

Data RestMethodMediaUploadProtocolsSimple

Show RestMethodMediaUploadProtocolsSimple

Generic RestMethodMediaUploadProtocolsSimple

ToJSON RestMethodMediaUploadProtocolsSimple

FromJSON RestMethodMediaUploadProtocolsSimple

type Rep RestMethodMediaUploadProtocolsSimple

restMethodMediaUploadProtocolsSimple :: RestMethodMediaUploadProtocolsSimple

Creates a value of RestMethodMediaUploadProtocolsSimple with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmupsPath
• rmmupsMultiPart

rmmupsPath :: Lens' RestMethodMediaUploadProtocolsSimple (Maybe Text)

The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

rmmupsMultiPart :: Lens' RestMethodMediaUploadProtocolsSimple Bool

True if this endpoint supports upload multipart media.

RestDescriptionIcons

data RestDescriptionIcons

Links to 16x16 and 32x32 icons representing the API.

See: restDescriptionIcons smart constructor.

Instances

Eq RestDescriptionIcons

Data RestDescriptionIcons

Show RestDescriptionIcons

Generic RestDescriptionIcons

ToJSON RestDescriptionIcons

FromJSON RestDescriptionIcons

type Rep RestDescriptionIcons

restDescriptionIcons :: RestDescriptionIcons

Creates a value of RestDescriptionIcons with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdiX16
• rdiX32

rdiX16 :: Lens' RestDescriptionIcons (Maybe Text)

The URL of the 16x16 icon.

rdiX32 :: Lens' RestDescriptionIcons (Maybe Text)

The URL of the 32x32 icon.

JSONSchemaVariant

data JSONSchemaVariant

In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.

See: jsonSchemaVariant smart constructor.

Instances

Eq JSONSchemaVariant

Data JSONSchemaVariant

Show JSONSchemaVariant

Generic JSONSchemaVariant

ToJSON JSONSchemaVariant

FromJSON JSONSchemaVariant

type Rep JSONSchemaVariant

jsonSchemaVariant :: JSONSchemaVariant

Creates a value of JSONSchemaVariant with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsvDiscriminant
• jsvMap

jsvDiscriminant :: Lens' JSONSchemaVariant (Maybe Text)

The name of the type discriminant property.

jsvMap :: Lens' JSONSchemaVariant [JSONSchemaVariantMapItem]

The map of discriminant value to schema to use for parsing..

RestResourceMethods

data RestResourceMethods

Methods on this resource.

See: restResourceMethods smart constructor.

Instances

Eq RestResourceMethods

Data RestResourceMethods

Show RestResourceMethods

Generic RestResourceMethods

ToJSON RestResourceMethods

FromJSON RestResourceMethods

type Rep RestResourceMethods

restResourceMethods

Arguments

:: HashMap Text RestMethod

rrmAddtional

-> RestResourceMethods

Creates a value of RestResourceMethods with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rrmAddtional

rrmAddtional :: Lens' RestResourceMethods (HashMap Text RestMethod)

Description for any methods on this resource.

RestDescriptionAuth

data RestDescriptionAuth

Authentication information.

See: restDescriptionAuth smart constructor.

Instances

Eq RestDescriptionAuth

Data RestDescriptionAuth

Show RestDescriptionAuth

Generic RestDescriptionAuth

ToJSON RestDescriptionAuth

FromJSON RestDescriptionAuth

type Rep RestDescriptionAuth

restDescriptionAuth :: RestDescriptionAuth

Creates a value of RestDescriptionAuth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdaOAuth2

rdaOAuth2 :: Lens' RestDescriptionAuth (Maybe RestDescriptionAuthOAuth2)

OAuth 2.0 authentication information.

RestDescription

data RestDescription

Instances

Eq RestDescription

Data RestDescription

Show RestDescription

Generic RestDescription

ToJSON RestDescription

FromJSON RestDescription

type Rep RestDescription

restDescription :: RestDescription

Creates a value of RestDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdEtag
• rdSchemas
• rdServicePath
• rdBasePath
• rdKind
• rdExponentialBackoffDefault
• rdAuth
• rdIcons
• rdBaseURL
• rdProtocol
• rdOwnerName
• rdResources
• rdOwnerDomain
• rdBatchPath
• rdMethods
• rdName
• rdPackagePath
• rdFeatures
• rdVersion
• rdParameters
• rdDocumentationLink
• rdRootURL
• rdId
• rdCanonicalName
• rdLabels
• rdDiscoveryVersion
• rdTitle
• rdRevision
• rdDescription

rdEtag :: Lens' RestDescription (Maybe Text)

The ETag for this response.

rdSchemas :: Lens' RestDescription (Maybe RestDescriptionSchemas)

The schemas for this API.

rdServicePath :: Lens' RestDescription (Maybe Text)

The base path for all REST requests.

rdBasePath :: Lens' RestDescription (Maybe Text)

DEPRECATED

The base path for REST requests.

rdKind :: Lens' RestDescription Text

The kind for this response.

rdExponentialBackoffDefault :: Lens' RestDescription (Maybe Bool)

Enable exponential backoff for suitable methods in the generated clients.

rdAuth :: Lens' RestDescription (Maybe RestDescriptionAuth)

Authentication information.

rdIcons :: Lens' RestDescription (Maybe RestDescriptionIcons)

Links to 16x16 and 32x32 icons representing the API.

rdBaseURL :: Lens' RestDescription (Maybe Text)

DEPRECATED

The base URL for REST requests.

rdProtocol :: Lens' RestDescription Text

The protocol described by this document.

rdOwnerName :: Lens' RestDescription (Maybe Text)

The name of the owner of this API. See ownerDomain.

rdResources :: Lens' RestDescription (Maybe RestDescriptionResources)

The resources in this API.

rdOwnerDomain :: Lens' RestDescription (Maybe Text)

The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.

rdBatchPath :: Lens' RestDescription Text

The path for REST batch requests.

rdMethods :: Lens' RestDescription (Maybe RestDescriptionMethods)

API-level methods for this API.

rdName :: Lens' RestDescription (Maybe Text)

The name of this API.

rdPackagePath :: Lens' RestDescription (Maybe Text)

The package of the owner of this API. See ownerDomain.

rdFeatures :: Lens' RestDescription [Text]

A list of supported features for this API.

rdVersion :: Lens' RestDescription (Maybe Text)

The version of this API.

rdParameters :: Lens' RestDescription (Maybe RestDescriptionParameters)

Common parameters that apply across all apis.

rdDocumentationLink :: Lens' RestDescription (Maybe Text)

A link to human readable documentation for the API.

rdRootURL :: Lens' RestDescription (Maybe Text)

The root URL under which all API services live.

rdId :: Lens' RestDescription (Maybe Text)

The ID of this API.

rdCanonicalName :: Lens' RestDescription (Maybe Text)

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

rdLabels :: Lens' RestDescription [Text]

Labels for the status of this API, such as labs or deprecated.

rdDiscoveryVersion :: Lens' RestDescription Text

Indicate the version of the Discovery API used to generate this doc.

rdTitle :: Lens' RestDescription (Maybe Text)

The title of this API.

rdRevision :: Lens' RestDescription (Maybe Text)

The version of this API.

rdDescription :: Lens' RestDescription (Maybe Text)

The description of this API.

JSONSchema

data JSONSchema

Instances

Eq JSONSchema

Data JSONSchema

Show JSONSchema

Generic JSONSchema

ToJSON JSONSchema

FromJSON JSONSchema

type Rep JSONSchema

jsonSchema :: JSONSchema

Creates a value of JSONSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsAnnotations
• jsVariant
• jsLocation
• jsRef
• jsPattern
• jsMaximum
• jsDefault
• jsFormat
• jsItems
• jsMinimum
• jsRequired
• jsId
• jsAdditionalProperties
• jsType
• jsEnum
• jsRepeated
• jsReadOnly
• jsEnumDescriptions
• jsDescription
• jsProperties

jsAnnotations :: Lens' JSONSchema (Maybe JSONSchemaAnnotations)

Additional information about this property.

jsVariant :: Lens' JSONSchema (Maybe JSONSchemaVariant)

In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.

jsLocation :: Lens' JSONSchema (Maybe Text)

Whether this parameter goes in the query or the path for REST requests.

jsRef :: Lens' JSONSchema (Maybe Text)

A reference to another schema. The value of this property is the "id" of another schema.

jsPattern :: Lens' JSONSchema (Maybe Text)

The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html

jsMaximum :: Lens' JSONSchema (Maybe Text)

The maximum value of this parameter.

jsDefault :: Lens' JSONSchema (Maybe Text)

The default value of this property (if one exists).

jsFormat :: Lens' JSONSchema (Maybe Text)

An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23

jsItems :: Lens' JSONSchema (Maybe JSONSchema)

If this is a schema for an array, this property is the schema for each element in the array.

jsMinimum :: Lens' JSONSchema (Maybe Text)

The minimum value of this parameter.

jsRequired :: Lens' JSONSchema (Maybe Bool)

Whether the parameter is required.

jsId :: Lens' JSONSchema (Maybe Text)

Unique identifier for this schema.

jsAdditionalProperties :: Lens' JSONSchema (Maybe JSONSchema)

If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.

jsType :: Lens' JSONSchema (Maybe Text)

The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1

jsEnum :: Lens' JSONSchema [Text]

Values this parameter may take (if it is an enum).

jsRepeated :: Lens' JSONSchema (Maybe Bool)

Whether this parameter may appear multiple times.

jsReadOnly :: Lens' JSONSchema (Maybe Bool)

The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.

jsEnumDescriptions :: Lens' JSONSchema [Text]

The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

jsDescription :: Lens' JSONSchema (Maybe Text)

A description of this object.

jsProperties :: Lens' JSONSchema (Maybe JSONSchemaProperties)

If this is a schema for an object, list the schema for each property of this object.

RestDescriptionSchemas

data RestDescriptionSchemas

The schemas for this API.

See: restDescriptionSchemas smart constructor.

Instances

Eq RestDescriptionSchemas

Data RestDescriptionSchemas

Show RestDescriptionSchemas

Generic RestDescriptionSchemas

ToJSON RestDescriptionSchemas

FromJSON RestDescriptionSchemas

type Rep RestDescriptionSchemas

restDescriptionSchemas

Arguments

:: HashMap Text JSONSchema

rdsAddtional

-> RestDescriptionSchemas

Creates a value of RestDescriptionSchemas with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdsAddtional

rdsAddtional :: Lens' RestDescriptionSchemas (HashMap Text JSONSchema)

An individual schema description.

JSONSchemaVariantMapItem

data JSONSchemaVariantMapItem

Instances

Eq JSONSchemaVariantMapItem

Data JSONSchemaVariantMapItem

Show JSONSchemaVariantMapItem

Generic JSONSchemaVariantMapItem

ToJSON JSONSchemaVariantMapItem

FromJSON JSONSchemaVariantMapItem

type Rep JSONSchemaVariantMapItem

jsonSchemaVariantMapItem :: JSONSchemaVariantMapItem

Creates a value of JSONSchemaVariantMapItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsvmiRef
• jsvmiTypeValue

jsvmiRef :: Lens' JSONSchemaVariantMapItem (Maybe Text)

jsvmiTypeValue :: Lens' JSONSchemaVariantMapItem (Maybe Text)

RestDescriptionResources

data RestDescriptionResources

The resources in this API.

See: restDescriptionResources smart constructor.

Instances

Eq RestDescriptionResources

Data RestDescriptionResources

Show RestDescriptionResources

Generic RestDescriptionResources

ToJSON RestDescriptionResources

FromJSON RestDescriptionResources

type Rep RestDescriptionResources

restDescriptionResources

Arguments

:: HashMap Text RestResource

rdrAddtional

-> RestDescriptionResources

Creates a value of RestDescriptionResources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdrAddtional

rdrAddtional :: Lens' RestDescriptionResources (HashMap Text RestResource)

An individual resource description. Contains methods and sub-resources related to this resource.

RestMethodMediaUploadProtocols

data RestMethodMediaUploadProtocols

Supported upload protocols.

See: restMethodMediaUploadProtocols smart constructor.

Instances

Eq RestMethodMediaUploadProtocols

Data RestMethodMediaUploadProtocols

Show RestMethodMediaUploadProtocols

Generic RestMethodMediaUploadProtocols

ToJSON RestMethodMediaUploadProtocols

FromJSON RestMethodMediaUploadProtocols

type Rep RestMethodMediaUploadProtocols

restMethodMediaUploadProtocols :: RestMethodMediaUploadProtocols

Creates a value of RestMethodMediaUploadProtocols with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmupSimple
• rmmupResumable

rmmupSimple :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsSimple)

Supports uploading as a single HTTP request.

rmmupResumable :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsResumable)

Supports the Resumable Media Upload protocol.

JSONSchemaAnnotations

data JSONSchemaAnnotations

Additional information about this property.

See: jsonSchemaAnnotations smart constructor.

Instances

Eq JSONSchemaAnnotations

Data JSONSchemaAnnotations

Show JSONSchemaAnnotations

Generic JSONSchemaAnnotations

ToJSON JSONSchemaAnnotations

FromJSON JSONSchemaAnnotations

type Rep JSONSchemaAnnotations

jsonSchemaAnnotations :: JSONSchemaAnnotations

Creates a value of JSONSchemaAnnotations with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jsaRequired

jsaRequired :: Lens' JSONSchemaAnnotations [Text]

A list of methods for which this property is required on requests.

RestMethodParameters

data RestMethodParameters

Details for all parameters in this method.

See: restMethodParameters smart constructor.

Instances

Eq RestMethodParameters

Data RestMethodParameters

Show RestMethodParameters

Generic RestMethodParameters

ToJSON RestMethodParameters

FromJSON RestMethodParameters

type Rep RestMethodParameters

restMethodParameters

Arguments

:: HashMap Text JSONSchema

rmpAddtional

-> RestMethodParameters

Creates a value of RestMethodParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmpAddtional

rmpAddtional :: Lens' RestMethodParameters (HashMap Text JSONSchema)

Details for a single parameter in this method.

RestMethodMediaUpload

data RestMethodMediaUpload

Media upload parameters.

See: restMethodMediaUpload smart constructor.

Instances

Eq RestMethodMediaUpload

Data RestMethodMediaUpload

Show RestMethodMediaUpload

Generic RestMethodMediaUpload

ToJSON RestMethodMediaUpload

FromJSON RestMethodMediaUpload

type Rep RestMethodMediaUpload

restMethodMediaUpload :: RestMethodMediaUpload

Creates a value of RestMethodMediaUpload with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmuProtocols
• rmmuAccept
• rmmuMaxSize

rmmuProtocols :: Lens' RestMethodMediaUpload (Maybe RestMethodMediaUploadProtocols)

Supported upload protocols.

rmmuAccept :: Lens' RestMethodMediaUpload [Text]

MIME Media Ranges for acceptable media uploads to this method.

rmmuMaxSize :: Lens' RestMethodMediaUpload (Maybe Text)

Maximum size of a media upload, such as "1MB", "2GB" or "3TB".

JSONSchemaProperties

data JSONSchemaProperties

If this is a schema for an object, list the schema for each property of this object.

See: jsonSchemaProperties smart constructor.

Instances

Eq JSONSchemaProperties

Data JSONSchemaProperties

Show JSONSchemaProperties

Generic JSONSchemaProperties

ToJSON JSONSchemaProperties

FromJSON JSONSchemaProperties

type Rep JSONSchemaProperties

jsonSchemaProperties

Arguments

:: HashMap Text JSONSchema

jspAddtional

-> JSONSchemaProperties

Creates a value of JSONSchemaProperties with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jspAddtional

jspAddtional :: Lens' JSONSchemaProperties (HashMap Text JSONSchema)

A single property of this object. The value is itself a JSON Schema object describing this property.

RestMethodMediaUploadProtocolsResumable

data RestMethodMediaUploadProtocolsResumable

Supports the Resumable Media Upload protocol.

See: restMethodMediaUploadProtocolsResumable smart constructor.

Instances

Eq RestMethodMediaUploadProtocolsResumable

Data RestMethodMediaUploadProtocolsResumable

Show RestMethodMediaUploadProtocolsResumable

Generic RestMethodMediaUploadProtocolsResumable

ToJSON RestMethodMediaUploadProtocolsResumable

FromJSON RestMethodMediaUploadProtocolsResumable

type Rep RestMethodMediaUploadProtocolsResumable

restMethodMediaUploadProtocolsResumable :: RestMethodMediaUploadProtocolsResumable

Creates a value of RestMethodMediaUploadProtocolsResumable with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rmmuprPath
• rmmuprMultiPart

rmmuprPath :: Lens' RestMethodMediaUploadProtocolsResumable (Maybe Text)

The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.

rmmuprMultiPart :: Lens' RestMethodMediaUploadProtocolsResumable Bool

True if this endpoint supports uploading multipart media.

DirectoryList

data DirectoryList

Instances

Eq DirectoryList

Data DirectoryList

Show DirectoryList

Generic DirectoryList

ToJSON DirectoryList

FromJSON DirectoryList

type Rep DirectoryList

directoryList :: DirectoryList

Creates a value of DirectoryList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dlKind
• dlItems
• dlDiscoveryVersion

dlKind :: Lens' DirectoryList Text

The kind for this response.

dlItems :: Lens' DirectoryList [DirectoryListItemsItem]

The individual directory entries. One entry per api/version pair.

dlDiscoveryVersion :: Lens' DirectoryList Text

Indicate the version of the Discovery API used to generate this doc.

RestMethodRequest

data RestMethodRequest

The schema for the request.

See: restMethodRequest smart constructor.

Instances

Eq RestMethodRequest

Data RestMethodRequest

Show RestMethodRequest

Generic RestMethodRequest

ToJSON RestMethodRequest

FromJSON RestMethodRequest

type Rep RestMethodRequest

restMethodRequest :: RestMethodRequest

Creates a value of RestMethodRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rRef
• rParameterName

rRef :: Lens' RestMethodRequest (Maybe Text)

Schema ID for the request schema.

rParameterName :: Lens' RestMethodRequest (Maybe Text)

parameter name.