Movatterモバイル変換

[0]ホーム
URL:

firebasestorage

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package firebasestorage provides access to the Cloud Storage for Firebase API.

For product documentation, see:https://firebase.google.com/docs/storage

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/firebasestorage/v1beta"...ctx := context.Background()firebasestorageService, err := firebasestorage.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

firebasestorageService, err := firebasestorage.NewService(ctx, option.WithScopes(firebasestorage.FirebaseScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

firebasestorageService, err := firebasestorage.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)firebasestorageService, err := firebasestorage.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View and administer all your Firebase data and settingsFirebaseScope = "https://www.googleapis.com/auth/firebase")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAddFirebaseRequest

type AddFirebaseRequest struct {}

AddFirebaseRequest: The request used to link a Google Cloud Storage bucketto a Firebase project.

typeBucket

type Bucket struct {// Name: Output only. Resource name of the bucket.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Bucket: A storage bucket and its relation to a parent Firebase project.

func (Bucket)MarshalJSON

func (sBucket) MarshalJSON() ([]byte,error)

typeDefaultBucketadded inv0.207.0

type DefaultBucket struct {// Bucket: Output only. Underlying bucket resource.Bucket *Bucket `json:"bucket,omitempty"`// Location: Immutable. Location of the default bucket.Locationstring `json:"location,omitempty"`// Name: Identifier. Resource name of the default bucket.Namestring `json:"name,omitempty"`// StorageClass: Immutable. Storage class of the default bucket. Supported// values are available at//https://cloud.google.com/storage/docs/storage-classes#classes.StorageClassstring `json:"storageClass,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Bucket") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Bucket") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DefaultBucket: Spark tier-eligible Cloud Storage bucket. One per project.This resource exists if the underlying Cloud Storage bucket exists and it islinked to your Firebase project. Seehttps://firebase.google.com/pricing forpricing details.

func (DefaultBucket)MarshalJSONadded inv0.207.0

func (sDefaultBucket) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeListBucketsResponse

type ListBucketsResponse struct {// Buckets: The list of linked buckets.Buckets []*Bucket `json:"buckets,omitempty"`// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Buckets") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Buckets") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListBucketsResponse: The response returned by `ListBuckets`.

func (ListBucketsResponse)MarshalJSON

func (sListBucketsResponse) MarshalJSON() ([]byte,error)

typeProjectsBucketsAddFirebaseCall

type ProjectsBucketsAddFirebaseCall struct {// contains filtered or unexported fields}

func (*ProjectsBucketsAddFirebaseCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsBucketsAddFirebaseCall)Do

Do executes the "firebasestorage.projects.buckets.addFirebase" call.Any non-2xx status code is an error. Response headers are in either*Bucket.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsBucketsAddFirebaseCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsBucketsAddFirebaseCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsBucketsGetCall

type ProjectsBucketsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsBucketsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsBucketsGetCall)Do

Do executes the "firebasestorage.projects.buckets.get" call.Any non-2xx status code is an error. Response headers are in either*Bucket.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsBucketsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsBucketsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsBucketsGetCall)IfNoneMatch

func (c *ProjectsBucketsGetCall) IfNoneMatch(entityTagstring) *ProjectsBucketsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsBucketsListCall

type ProjectsBucketsListCall struct {// contains filtered or unexported fields}

func (*ProjectsBucketsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsBucketsListCall)Do

Do executes the "firebasestorage.projects.buckets.list" call.Any non-2xx status code is an error. Response headers are in either*ListBucketsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsBucketsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsBucketsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsBucketsListCall)IfNoneMatch

func (c *ProjectsBucketsListCall) IfNoneMatch(entityTagstring) *ProjectsBucketsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsBucketsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofbuckets to return. If not set, the server will use a reasonable default.

func (*ProjectsBucketsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListBuckets` call. Provide this to retrieve the subsequentpage. When paginating, all other parameters provided to `ListBuckets` mustmatch the call that provided the page token.

func (*ProjectsBucketsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsBucketsRemoveFirebaseCall

type ProjectsBucketsRemoveFirebaseCall struct {// contains filtered or unexported fields}

func (*ProjectsBucketsRemoveFirebaseCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsBucketsRemoveFirebaseCall)Do

Do executes the "firebasestorage.projects.buckets.removeFirebase" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsBucketsRemoveFirebaseCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsBucketsRemoveFirebaseCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsBucketsService

type ProjectsBucketsService struct {// contains filtered or unexported fields}

funcNewProjectsBucketsService

func NewProjectsBucketsService(s *Service) *ProjectsBucketsService

func (*ProjectsBucketsService)AddFirebase

func (r *ProjectsBucketsService) AddFirebase(bucketstring, addfirebaserequest *AddFirebaseRequest) *ProjectsBucketsAddFirebaseCall

AddFirebase: Links a Google Cloud Storage bucket to a Firebase project.

  • bucket: Resource name of the bucket, mirrors the ID of the underlyingGoogle Cloud Storage bucket,`projects/{project_id_or_number}/buckets/{bucket_id}`.

func (*ProjectsBucketsService)Get

Get: Gets a single linked storage bucket.

  • name: Resource name of the bucket, mirrors the ID of the underlying GoogleCloud Storage bucket,`projects/{project_id_or_number}/buckets/{bucket_id}`.

func (*ProjectsBucketsService)List

List: Lists the linked storage buckets for a project.

  • parent: Resource name of the parent Firebase project,`projects/{project_id_or_number}`.

func (*ProjectsBucketsService)RemoveFirebase

func (r *ProjectsBucketsService) RemoveFirebase(bucketstring, removefirebaserequest *RemoveFirebaseRequest) *ProjectsBucketsRemoveFirebaseCall

RemoveFirebase: Unlinks a linked Google Cloud Storage bucket from a Firebaseproject.

  • bucket: Resource name of the bucket, mirrors the ID of the underlyingGoogle Cloud Storage bucket,`projects/{project_id_or_number}/buckets/{bucket_id}`.

typeProjectsDefaultBucketCreateCalladded inv0.207.0

type ProjectsDefaultBucketCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsDefaultBucketCreateCall)Contextadded inv0.207.0

Context sets the context to be used in this call's Do method.

func (*ProjectsDefaultBucketCreateCall)Doadded inv0.207.0

Do executes the "firebasestorage.projects.defaultBucket.create" call.Any non-2xx status code is an error. Response headers are in either*DefaultBucket.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDefaultBucketCreateCall)Fieldsadded inv0.207.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDefaultBucketCreateCall)Headeradded inv0.207.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsDefaultBucketServiceadded inv0.207.0

type ProjectsDefaultBucketService struct {// contains filtered or unexported fields}

funcNewProjectsDefaultBucketServiceadded inv0.207.0

func NewProjectsDefaultBucketService(s *Service) *ProjectsDefaultBucketService

func (*ProjectsDefaultBucketService)Createadded inv0.207.0

Create: Creates a Spark tier-eligible Cloud Storage bucket and links it toyour Firebase project. If the default bucket already exists, this methodwill re-link it to your Firebase project. Seehttps://firebase.google.com/pricing for pricing details.

  • parent: The parent resource where the default bucket will be created,`projects/{project_id_or_number}`.

typeProjectsDeleteDefaultBucketCalladded inv0.207.0

type ProjectsDeleteDefaultBucketCall struct {// contains filtered or unexported fields}

func (*ProjectsDeleteDefaultBucketCall)Contextadded inv0.207.0

Context sets the context to be used in this call's Do method.

func (*ProjectsDeleteDefaultBucketCall)Doadded inv0.207.0

Do executes the "firebasestorage.projects.deleteDefaultBucket" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDeleteDefaultBucketCall)Fieldsadded inv0.207.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDeleteDefaultBucketCall)Headeradded inv0.207.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsGetDefaultBucketCalladded inv0.207.0

type ProjectsGetDefaultBucketCall struct {// contains filtered or unexported fields}

func (*ProjectsGetDefaultBucketCall)Contextadded inv0.207.0

Context sets the context to be used in this call's Do method.

func (*ProjectsGetDefaultBucketCall)Doadded inv0.207.0

Do executes the "firebasestorage.projects.getDefaultBucket" call.Any non-2xx status code is an error. Response headers are in either*DefaultBucket.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetDefaultBucketCall)Fieldsadded inv0.207.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGetDefaultBucketCall)Headeradded inv0.207.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGetDefaultBucketCall)IfNoneMatchadded inv0.207.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsService

type ProjectsService struct {Buckets *ProjectsBucketsServiceDefaultBucket *ProjectsDefaultBucketService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService)DeleteDefaultBucketadded inv0.207.0

func (r *ProjectsService) DeleteDefaultBucket(namestring) *ProjectsDeleteDefaultBucketCall

DeleteDefaultBucket: Unlinks and deletes the default bucket.

  • name: The name of the default bucket to delete,`projects/{project_id_or_number}/defaultBucket`.

func (*ProjectsService)GetDefaultBucketadded inv0.207.0

func (r *ProjectsService) GetDefaultBucket(namestring) *ProjectsGetDefaultBucketCall

GetDefaultBucket: Gets the default bucket.

  • name: The name of the default bucket to retrieve,`projects/{project_id_or_number}/defaultBucket`.

typeRemoveFirebaseRequest

type RemoveFirebaseRequest struct {}

RemoveFirebaseRequest: The request used to unlink a Google Cloud Storagebucket from a Firebase project.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp