Docs
Launch GraphOS Studio


STRUCT

ApolloSchemaDownloadConfiguration

public struct ApolloSchemaDownloadConfiguration: Equatable, Codable

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 (in seconds) to wait before indicating that the download timed out. Defaults to 30 seconds.

headers

public let headers: [HTTPHeader]

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

outputPath

public let outputPath: String

The local path where the downloaded schema should be written to.

outputFormat

public var outputFormat: DownloadMethod.OutputFormat

Methods

init(using:timeout:headers:outputPath:)

public init(
using downloadMethod: DownloadMethod,
timeout downloadTimeout: Double = 30.0,
headers: [HTTPHeader] = [],
outputPath: String
)

Designated Initializer

  • Parameters:
    • downloadMethod: How to download your schema.
    • downloadTimeout: The maximum time (in seconds) to wait before indicating that the
    download timed out. Defaults to 30 seconds.
    • headers: [optional] Any additional headers to include when retrieving your schema.
    Defaults to nil
    • outputPath: The local path where the downloaded schema should be written to.

Parameters

NameDescription
downloadMethodHow to download your schema.
downloadTimeoutThe maximum time (in seconds) to wait before indicating that the download timed out. Defaults to 30 seconds.
headers[optional] Any additional headers to include when retrieving your schema. Defaults to nil
outputPathThe local path where the downloaded schema should be written to.
Next
Introduction
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company