gcs

Documentation

Overview

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Read(ctx context.Context, response http.ResponseWriter, request *http.Request, ...)
• func ReadMetadata(ctx context.Context, response http.ResponseWriter, request *http.Request, ...)
• func ReadWithCache(ctx context.Context, response http.ResponseWriter, request *http.Request, ...)
• func Setup() error
• type CacheGet

Functions

func Read

func Read(ctx context.Context, response http.ResponseWriter,
	request *http.Request, pipeline filter.Pipeline)

Read returns objects from a GCS bucket, mapping the URL to object names. Media caching is bypassed.

func ReadMetadata

func ReadMetadata(ctx context.Context, response http.ResponseWriter,
	request *http.Request, pipeline filter.Pipeline)

ReadMetadata returns object metadata from a GCS bucket, mapping the URL to object names.

func ReadWithCache

func ReadWithCache(ctx context.Context, response http.ResponseWriter,
	request *http.Request, missPipeline filter.Pipeline, cacheGet CacheGet,
	hitPipeline filter.Pipeline)

ReadWithCache returns objects from a GCS bucket, mapping the URL to object names. Cached media may be served, sparing a trip to GCS.

Filters in missPipeline will be applied on cache misses. A cache fill filter is a good idea here.

Filters in hitPipeline will be applied on cache hits. Reducing the pipeline to not repeat steps done on fill (e.g., compression, transcoding) is a good idea here.

func Setup

func Setup() error

setup performs one-time setup for the GCS backend.

Types

type CacheGet

type CacheGet func(string) ([]byte, bool)

CacheGet defines how CachedGet will try to get media from the cache.