Docs
Launch GraphOS Studio
You're viewing documentation for a previous version of this software. Switch to the latest stable version.


STRUCT

ApolloSchemaDownloadConfiguration

public struct ApolloSchemaDownloadConfiguration

A configuration object that defines behavior for schema download.

Properties

downloadMethod

public let downloadMethod: DownloadMethod

How to download your schema. Supports the Apollo Registry and methods.

downloadTimeout

public let downloadTimeout: Double

The maximum time to wait before indicating that the download timed out, in seconds. Defaults to 30 seconds.

headers

public let headers: [HTTPHeader]

Any additional headers to include when retrieving your schema. Defaults to nil.

outputURL

public let outputURL: URL

The URL of the folder in which the downloaded schema should be written.

Methods

init(using:timeout:headers:outputFolderURL:schemaFilename:)

public init(using downloadMethod: DownloadMethod,
timeout downloadTimeout: Double = 30.0,
headers: [HTTPHeader] = [],
outputFolderURL: URL,
schemaFilename: String = "schema")

Designated Initializer

  • Parameters:
    • downloadMethod: How to download your schema.
    • downloadTimeout: The maximum time to wait before indicating that the download timed out, in seconds. Defaults to 30 seconds.
    • headers: [optional] Any additional headers to include when retrieving your schema. Defaults to nil
    • outputFolderURL: The URL of the folder in which the downloaded schema should be written
    • schemaFilename: The name, without an extension, for your schema file. Defaults to `"schema"

Parameters

NameDescription
downloadMethodHow to download your schema.
downloadTimeoutThe maximum time to wait before indicating that the download timed out, in seconds. Defaults to 30 seconds.
headers[optional] Any additional headers to include when retrieving your schema. Defaults to nil
outputFolderURLThe URL of the folder in which the downloaded schema should be written
schemaFilenameThe name, without an extension, for your schema file. Defaults to `“schema”
Next
Introduction
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company