firebaseappcheck

package
v0.48.1-0...-67a0a95 Latest Latest
Warning

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

Go to latest
Published: Jun 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package firebaseappcheck provides access to the Firebase App Check API.

For product documentation, see: https://firebase.google.com/docs/app-check

Creating a client

Usage example:

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

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://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, use option.WithScopes:

firebaseappcheckService, err := firebaseappcheck.NewService(ctx, option.WithScopes(firebaseappcheck.FirebaseScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

firebaseappcheckService, err := firebaseappcheck.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View and administer all your Firebase data and settings
	FirebaseScope = "https://www.googleapis.com/auth/firebase"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleFirebaseAppcheckV1betaAttestationTokenResponse

type GoogleFirebaseAppcheckV1betaAttestationTokenResponse struct {
	// AttestationToken: An App Check token. App Check tokens are signed
	// JWTs (https://tools.ietf.org/html/rfc7519) containing claims that
	// identify the attested app and Firebase project. This token is used to
	// access Firebase services protected by App Check.
	AttestationToken string `json:"attestationToken,omitempty"`

	// Ttl: The duration from the time this token is minted until its
	// expiration. This field is intended to ease client-side token
	// management, since the client may have clock skew, but is still able
	// to accurately measure a duration.
	Ttl string `json:"ttl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AttestationToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttestationToken") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaAttestationTokenResponse: Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.

func (*GoogleFirebaseAppcheckV1betaAttestationTokenResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse

type GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse struct {
	// Configs: DeviceCheckConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaDeviceCheckConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Configs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Configs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse: Response message for the BatchGetDeviceCheckConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse struct {
	// Configs: RecaptchaConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaRecaptchaConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Configs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Configs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse: Response message for the BatchGetRecaptchaConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest struct {
	// Requests: Required. The request messages specifying the Services to
	// update. A maximum of 100 objects can be updated in a batch.
	Requests []*GoogleFirebaseAppcheckV1betaUpdateServiceRequest `json:"requests,omitempty"`

	// UpdateMask: Optional. A comma-separated list of names of fields in
	// the Services to update. Example: `display_name`. If this field is
	// present, the `update_mask` field in the UpdateServiceRequest messages
	// must all match this field, or the entire batch fails and no updates
	// will be committed.
	UpdateMask string `json:"updateMask,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Requests") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Requests") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest: Request message for the BatchUpdateServices method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse struct {
	// Services: Service objects after the updates have been applied.
	Services []*GoogleFirebaseAppcheckV1betaService `json:"services,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Services") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Services") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse: Response message for the BatchUpdateServices method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaDebugToken

type GoogleFirebaseAppcheckV1betaDebugToken struct {
	// DisplayName: Required. A human readable display name used to identify
	// this debug token.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The relative resource name of the debug token, in the format:
	// “`
	// projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id}
	// “`
	Name string `json:"name,omitempty"`

	// Token: Input only. Immutable. The secret token itself. Must be
	// provided during creation, and must be a UUID4, case insensitive. This
	// field is immutable once set, and cannot be provided during an
	// UpdateDebugToken request. You can, however, delete this debug token
	// using DeleteDebugToken to revoke it. For security reasons, this field
	// will never be populated in any response.
	Token string `json:"token,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaDebugToken: A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.

func (*GoogleFirebaseAppcheckV1betaDebugToken) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaDebugToken) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaDeviceCheckConfig

type GoogleFirebaseAppcheckV1betaDeviceCheckConfig struct {
	// KeyId: Required. The key identifier of a private key enabled with
	// DeviceCheck, created in your Apple Developer account.
	KeyId string `json:"keyId,omitempty"`

	// Name: Required. The relative resource name of the DeviceCheck
	// configuration object, in the format: “`
	// projects/{project_number}/apps/{app_id}/deviceCheckConfig “`
	Name string `json:"name,omitempty"`

	// PrivateKey: Required. Input only. The contents of the private key
	// (`.p8`) file associated with the key specified by `key_id`. For
	// security reasons, this field will never be populated in any response.
	PrivateKey string `json:"privateKey,omitempty"`

	// PrivateKeySet: Output only. Whether the `private_key` field was
	// previously set. Since we will never return the `private_key` field,
	// this field is the only way to find out whether it was previously set.
	PrivateKeySet bool `json:"privateKeySet,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "KeyId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "KeyId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaDeviceCheckConfig: An app's DeviceCheck configuration object. This configuration is used by ExchangeDeviceCheckToken to validate device tokens issued to apps by DeviceCheck.

func (*GoogleFirebaseAppcheckV1betaDeviceCheckConfig) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest struct {
	// CustomToken: A custom token signed using your project's Admin SDK
	// service account credentials.
	CustomToken string `json:"customToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CustomToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CustomToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest: Request message for the ExchangeCustomToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest struct {
	// DebugToken: A debug token secret. This string must match a debug
	// token secret previously created using CreateDebugToken.
	DebugToken string `json:"debugToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DebugToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DebugToken") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest: Request message for the ExchangeDebugToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest struct {
	// DeviceToken: The `device_token` as returned by Apple's client-side
	// DeviceCheck API
	// (https://developer.apple.com/documentation/devicecheck/dcdevice).
	// This is the Base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
	DeviceToken string `json:"deviceToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest: Request message for the ExchangeDeviceCheckToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest struct {
	// RecaptchaToken: The reCAPTCHA token as returned by the reCAPTCHA v3
	// JavaScript API (https://developers.google.com/recaptcha/docs/v3).
	RecaptchaToken string `json:"recaptchaToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RecaptchaToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RecaptchaToken") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest: Request message for the ExchangeRecaptchaToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest struct {
	// SafetyNetToken: The SafetyNet attestation response
	// (https://developer.android.com/training/safetynet/attestation#request-attestation-step)
	// issued to your app.
	SafetyNetToken string `json:"safetyNetToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SafetyNetToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SafetyNetToken") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest: Request message for the ExchangeSafetyNetToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaListDebugTokensResponse

type GoogleFirebaseAppcheckV1betaListDebugTokensResponse struct {
	// DebugTokens: The DebugTokens retrieved.
	DebugTokens []*GoogleFirebaseAppcheckV1betaDebugToken `json:"debugTokens,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty or
	// omitted, then this response is the last page of results. This token
	// can be used in a subsequent call to ListDebugTokens to find the next
	// group of DebugTokens. Page tokens are short-lived and should not be
	// persisted.
	NextPageToken string `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. "DebugTokens") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DebugTokens") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaListDebugTokensResponse: Response message for the ListDebugTokens method.

func (*GoogleFirebaseAppcheckV1betaListDebugTokensResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaListServicesResponse

type GoogleFirebaseAppcheckV1betaListServicesResponse struct {
	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token is returned. If the string is empty or
	// omitted, then this response is the last page of results. This token
	// can be used in a subsequent call to ListServices to find the next
	// group of Services. Page tokens are short-lived and should not be
	// persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Services: The Services retrieved.
	Services []*GoogleFirebaseAppcheckV1betaService `json:"services,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaListServicesResponse: Response message for the ListServices method.

func (*GoogleFirebaseAppcheckV1betaListServicesResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaPublicJwk

type GoogleFirebaseAppcheckV1betaPublicJwk struct {
	// Alg: See section 4.4 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.4).
	Alg string `json:"alg,omitempty"`

	// E: See section 6.3.1.2 of RFC 7518
	// (https://tools.ietf.org/html/rfc7518#section-6.3.1.2).
	E string `json:"e,omitempty"`

	// Kid: See section 4.5 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.5).
	Kid string `json:"kid,omitempty"`

	// Kty: See section 4.1 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.1).
	Kty string `json:"kty,omitempty"`

	// N: See section 6.3.1.1 of RFC 7518
	// (https://tools.ietf.org/html/rfc7518#section-6.3.1.1).
	N string `json:"n,omitempty"`

	// Use: See section 4.2 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.2).
	Use string `json:"use,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Alg") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Alg") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaPublicJwk: A JWK as specified by section 4 of RFC 7517 (https://tools.ietf.org/html/rfc7517#section-4) and section 6.3.1 of RFC 7518 (https://tools.ietf.org/html/rfc7518#section-6.3.1).

func (*GoogleFirebaseAppcheckV1betaPublicJwk) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaPublicJwk) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaPublicJwkSet

type GoogleFirebaseAppcheckV1betaPublicJwkSet struct {
	// Keys: The set of public keys. See section 5.1 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-5).
	Keys []*GoogleFirebaseAppcheckV1betaPublicJwk `json:"keys,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Keys") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Keys") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaPublicJwkSet: The currently active set of public keys that can be used to verify App Check tokens. This object is a JWK set as specified by section 5 of RFC 7517 (https://tools.ietf.org/html/rfc7517#section-5). For security, the response **must not** be cached for longer than one day.

func (*GoogleFirebaseAppcheckV1betaPublicJwkSet) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaPublicJwkSet) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaRecaptchaConfig

type GoogleFirebaseAppcheckV1betaRecaptchaConfig struct {
	// Name: Required. The relative resource name of the reCAPTCHA v3
	// configuration object, in the format: “`
	// projects/{project_number}/apps/{app_id}/recaptchaConfig “`
	Name string `json:"name,omitempty"`

	// SiteSecret: Required. Input only. The site secret used to identify
	// your service for reCAPTCHA v3 verification. For security reasons,
	// this field will never be populated in any response.
	SiteSecret string `json:"siteSecret,omitempty"`

	// SiteSecretSet: Output only. Whether the `site_secret` field was
	// previously set. Since we will never return the `site_secret` field,
	// this field is the only way to find out whether it was previously set.
	SiteSecretSet bool `json:"siteSecretSet,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaRecaptchaConfig: An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3.

func (*GoogleFirebaseAppcheckV1betaRecaptchaConfig) MarshalJSON

type GoogleFirebaseAppcheckV1betaService

type GoogleFirebaseAppcheckV1betaService struct {
	// EnforcementMode: Required. The App Check enforcement mode for this
	// service.
	//
	// Possible values:
	//   "OFF" - Firebase App Check is not enforced for the service, nor are
	// App Check metrics collected. Though the service is not protected by
	// App Check in this mode, other applicable protections, such as user
	// authorization, are still enforced. An unconfigured service is in this
	// mode by default.
	//   "UNENFORCED" - Firebase App Check is not enforced for the service.
	// App Check metrics are collected to help you decide when to turn on
	// enforcement for the service. Though the service is not protected by
	// App Check in this mode, other applicable protections, such as user
	// authorization, are still enforced.
	//   "ENFORCED" - Firebase App Check is enforced for the service. The
	// service will reject any request that attempts to access your
	// project's resources if it does not have valid App Check token
	// attached, with some exceptions depending on the service; for example,
	// some services will still allow requests bearing the developer's
	// privileged service account credentials without an App Check token.
	// App Check metrics continue to be collected to help you detect issues
	// with your App Check integration and monitor the composition of your
	// callers. While the service is protected by App Check, other
	// applicable protections, such as user authorization, continue to be
	// enforced at the same time. Use caution when choosing to enforce App
	// Check on a Firebase service. If your users have not updated to an App
	// Check capable version of your app, their apps will no longer be able
	// to use your Firebase services that are enforcing App Check. App Check
	// metrics can help you decide whether to enforce App Check on your
	// Firebase services. If your app has not launched yet, you should
	// enable enforcement immediately, since there are no outdated clients
	// in use.
	EnforcementMode string `json:"enforcementMode,omitempty"`

	// Name: Required. The relative resource name of the service
	// configuration object, in the format: “`
	// projects/{project_number}/services/{service_id} “` Note that the
	// `service_id` element must be a supported service ID. Currently, the
	// following service IDs are supported: *
	// `firebasestorage.googleapis.com` (Cloud Storage for Firebase) *
	// `firebasedatabase.googleapis.com` (Firebase Realtime Database)
	Name string `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. "EnforcementMode") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EnforcementMode") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaService: The enforcement configuration for a Firebase service supported by App Check.

func (*GoogleFirebaseAppcheckV1betaService) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaService) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaUpdateServiceRequest

type GoogleFirebaseAppcheckV1betaUpdateServiceRequest struct {
	// Service: Required. The Service to update. The Service's `name` field
	// is used to identify the Service to be updated, in the format: “`
	// projects/{project_number}/services/{service_id} “` Note that the
	// `service_id` element must be a supported service ID. Currently, the
	// following service IDs are supported: *
	// `firebasestorage.googleapis.com` (Cloud Storage for Firebase) *
	// `firebasedatabase.googleapis.com` (Firebase Realtime Database)
	Service *GoogleFirebaseAppcheckV1betaService `json:"service,omitempty"`

	// UpdateMask: Required. A comma-separated list of names of fields in
	// the Service to update. Example: `enforcement_mode`.
	UpdateMask string `json:"updateMask,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Service") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Service") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaUpdateServiceRequest: Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.

func (*GoogleFirebaseAppcheckV1betaUpdateServiceRequest) MarshalJSON

type GoogleProtobufEmpty

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

GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

type JwksGetCall

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

func (*JwksGetCall) Context

func (c *JwksGetCall) Context(ctx context.Context) *JwksGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*JwksGetCall) Do

Do executes the "firebaseappcheck.jwks.get" call. Exactly one of *GoogleFirebaseAppcheckV1betaPublicJwkSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaPublicJwkSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*JwksGetCall) Fields

func (c *JwksGetCall) Fields(s ...googleapi.Field) *JwksGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*JwksGetCall) Header

func (c *JwksGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*JwksGetCall) IfNoneMatch

func (c *JwksGetCall) IfNoneMatch(entityTag string) *JwksGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type JwksService

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

func NewJwksService

func NewJwksService(s *Service) *JwksService

func (*JwksService) Get

func (r *JwksService) Get(name string) *JwksGetCall

Get: Returns a public JWK set as specified by RFC 7517 (https://tools.ietf.org/html/rfc7517) that can be used to verify App Check tokens. Exactly one of the public keys in the returned set will successfully validate any App Check token that is currently valid.

  • name: The relative resource name to the public JWK set. Must always be exactly the string `jwks`.

type ProjectsAppsDebugTokensCreateCall

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

func (*ProjectsAppsDebugTokensCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDebugTokensCreateCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.create" call. Exactly one of *GoogleFirebaseAppcheckV1betaDebugToken or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDebugTokensCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsDebugTokensDeleteCall

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

func (*ProjectsAppsDebugTokensDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDebugTokensDeleteCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDebugTokensDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsDebugTokensGetCall

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

func (*ProjectsAppsDebugTokensGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDebugTokensGetCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.get" call. Exactly one of *GoogleFirebaseAppcheckV1betaDebugToken or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDebugTokensGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDebugTokensGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAppsDebugTokensListCall

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

func (*ProjectsAppsDebugTokensListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDebugTokensListCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.list" call. Exactly one of *GoogleFirebaseAppcheckV1betaListDebugTokensResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaListDebugTokensResponse.ServerResponse.He ader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDebugTokensListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDebugTokensListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAppsDebugTokensListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of DebugTokens to return in the response. Note that an app can have at most 20 debug tokens. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

func (*ProjectsAppsDebugTokensListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to ListDebugTokens indicating where in the set of DebugTokens to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDebugTokens must match the call that provided the page token; if they do not match, the result is undefined.

func (*ProjectsAppsDebugTokensListCall) 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.

type ProjectsAppsDebugTokensPatchCall

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

func (*ProjectsAppsDebugTokensPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDebugTokensPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.patch" call. Exactly one of *GoogleFirebaseAppcheckV1betaDebugToken or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDebugTokensPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDebugTokensPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the DebugToken to update. Example: `display_name`.

type ProjectsAppsDebugTokensService

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

func NewProjectsAppsDebugTokensService

func NewProjectsAppsDebugTokensService(s *Service) *ProjectsAppsDebugTokensService

func (*ProjectsAppsDebugTokensService) Create

func (r *ProjectsAppsDebugTokensService) Create(parent string, googlefirebaseappcheckv1betadebugtoken *GoogleFirebaseAppcheckV1betaDebugToken) *ProjectsAppsDebugTokensCreateCall

Create: Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.

  • parent: The relative resource name of the parent app in which the specified DebugToken will be created, in the format: ``` projects/{project_number}/apps/{app_id} ```.

func (*ProjectsAppsDebugTokensService) Delete

Delete: Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.

  • name: The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

func (*ProjectsAppsDebugTokensService) Get

Get: Gets the specified DebugToken. For security reasons, the `token` field is never populated in the response.

  • name: The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

func (*ProjectsAppsDebugTokensService) List

List: Lists all DebugTokens for the specified app. For security reasons, the `token` field is never populated in the response.

  • parent: The relative resource name of the parent app for which to list each associated DebugToken, in the format: ``` projects/{project_number}/apps/{app_id} ```.

func (*ProjectsAppsDebugTokensService) Patch

Patch: Updates the specified DebugToken. For security reasons, the `token` field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.

  • name: The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

type ProjectsAppsDeviceCheckConfigBatchGetCall

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

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.batchGet" call. Exactly one of *GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse.Server Response.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Names

Names sets the optional parameter "names": Required. The relative resource names of the DeviceCheckConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsDeviceCheckConfigGetCall

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

func (*ProjectsAppsDeviceCheckConfigGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDeviceCheckConfigGetCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.get" call. Exactly one of *GoogleFirebaseAppcheckV1betaDeviceCheckConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDeviceCheckConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDeviceCheckConfigGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDeviceCheckConfigGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAppsDeviceCheckConfigPatchCall

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

func (*ProjectsAppsDeviceCheckConfigPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.patch" call. Exactly one of *GoogleFirebaseAppcheckV1betaDeviceCheckConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDeviceCheckConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsDeviceCheckConfigPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the DeviceCheckConfig Gets to update. Example: `key_id,private_key`.

type ProjectsAppsDeviceCheckConfigService

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

func NewProjectsAppsDeviceCheckConfigService

func NewProjectsAppsDeviceCheckConfigService(s *Service) *ProjectsAppsDeviceCheckConfigService

func (*ProjectsAppsDeviceCheckConfigService) BatchGet

BatchGet: Gets the DeviceCheckConfigs for the specified list of apps atomically. For security reasons, the `private_key` field is never populated in the response.

  • parent: The parent project name shared by all DeviceCheckConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsDeviceCheckConfigService) Get

Get: Gets the DeviceCheckConfig for the specified app. For security reasons, the `private_key` field is never populated in the response.

  • name: The relative resource name of the DeviceCheckConfig, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ```.

func (*ProjectsAppsDeviceCheckConfigService) Patch

Patch: Updates the DeviceCheckConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange DeviceCheck tokens for App Check tokens. For security reasons, the `private_key` field is never populated in the response.

  • name: The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ```.

type ProjectsAppsExchangeCustomTokenCall

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

func (*ProjectsAppsExchangeCustomTokenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsExchangeCustomTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeCustomToken" call. Exactly one of *GoogleFirebaseAppcheckV1betaAttestationTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAttestationTokenResponse.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeCustomTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsExchangeCustomTokenCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsExchangeDebugTokenCall

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

func (*ProjectsAppsExchangeDebugTokenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsExchangeDebugTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeDebugToken" call. Exactly one of *GoogleFirebaseAppcheckV1betaAttestationTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAttestationTokenResponse.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeDebugTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsExchangeDebugTokenCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsExchangeDeviceCheckTokenCall

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

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeDeviceCheckToken" call. Exactly one of *GoogleFirebaseAppcheckV1betaAttestationTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAttestationTokenResponse.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsExchangeRecaptchaTokenCall

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

func (*ProjectsAppsExchangeRecaptchaTokenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeRecaptchaToken" call. Exactly one of *GoogleFirebaseAppcheckV1betaAttestationTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAttestationTokenResponse.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsExchangeSafetyNetTokenCall

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

func (*ProjectsAppsExchangeSafetyNetTokenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeSafetyNetToken" call. Exactly one of *GoogleFirebaseAppcheckV1betaAttestationTokenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAttestationTokenResponse.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsAppsRecaptchaConfigBatchGetCall

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

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.batchGet" call. Exactly one of *GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse.ServerRe sponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Names

Names sets the optional parameter "names": Required. The relative resource names of the RecaptchaConfigs to retrieve, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsRecaptchaConfigGetCall

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

func (*ProjectsAppsRecaptchaConfigGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsRecaptchaConfigGetCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.get" call. Exactly one of *GoogleFirebaseAppcheckV1betaRecaptchaConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsRecaptchaConfigGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsRecaptchaConfigGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAppsRecaptchaConfigPatchCall

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

func (*ProjectsAppsRecaptchaConfigPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAppsRecaptchaConfigPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.patch" call. Exactly one of *GoogleFirebaseAppcheckV1betaRecaptchaConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAppsRecaptchaConfigPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsAppsRecaptchaConfigPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the RecaptchaConfig to update. Example: `site_secret`.

type ProjectsAppsRecaptchaConfigService

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

func NewProjectsAppsRecaptchaConfigService

func NewProjectsAppsRecaptchaConfigService(s *Service) *ProjectsAppsRecaptchaConfigService

func (*ProjectsAppsRecaptchaConfigService) BatchGet

BatchGet: Gets the RecaptchaConfigs for the specified list of apps atomically. For security reasons, the `site_secret` field is never populated in the response.

  • parent: The parent project name shared by all RecaptchaConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsRecaptchaConfigService) Get

Get: Gets the RecaptchaConfig for the specified app. For security reasons, the `site_secret` field is never populated in the response.

  • name: The relative resource name of the RecaptchaConfig, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```.

func (*ProjectsAppsRecaptchaConfigService) Patch

Patch: Updates the RecaptchaConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.

  • name: The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```.

type ProjectsAppsService

type ProjectsAppsService struct {
	DebugTokens *ProjectsAppsDebugTokensService

	DeviceCheckConfig *ProjectsAppsDeviceCheckConfigService

	RecaptchaConfig *ProjectsAppsRecaptchaConfigService
	// contains filtered or unexported fields
}

func NewProjectsAppsService

func NewProjectsAppsService(s *Service) *ProjectsAppsService

func (*ProjectsAppsService) ExchangeCustomToken

func (r *ProjectsAppsService) ExchangeCustomToken(appid string, googlefirebaseappcheckv1betaexchangecustomtokenrequest *GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest) *ProjectsAppsExchangeCustomTokenCall

ExchangeCustomToken: Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeDebugToken

func (r *ProjectsAppsService) ExchangeDebugToken(appid string, googlefirebaseappcheckv1betaexchangedebugtokenrequest *GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest) *ProjectsAppsExchangeDebugTokenCall

ExchangeDebugToken: Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an App Check token encapsulated in an AttestationTokenResponse. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeDeviceCheckToken

func (r *ProjectsAppsService) ExchangeDeviceCheckToken(appid string, googlefirebaseappcheckv1betaexchangedevicechecktokenrequest *GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest) *ProjectsAppsExchangeDeviceCheckTokenCall

ExchangeDeviceCheckToken: Accepts a `device_token` (https://developer.apple.com/documentation/devicecheck/dcdevice) issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeRecaptchaToken

func (r *ProjectsAppsService) ExchangeRecaptchaToken(appid string, googlefirebaseappcheckv1betaexchangerecaptchatokenrequest *GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest) *ProjectsAppsExchangeRecaptchaTokenCall

ExchangeRecaptchaToken: Validates a reCAPTCHA v3 response token (https://developers.google.com/recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.

  • app: The relative resource name of the web app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeSafetyNetToken

func (r *ProjectsAppsService) ExchangeSafetyNetToken(appid string, googlefirebaseappcheckv1betaexchangesafetynettokenrequest *GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest) *ProjectsAppsExchangeSafetyNetTokenCall

ExchangeSafetyNetToken: Validates a SafetyNet token (https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.

  • app: The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

type ProjectsService

type ProjectsService struct {
	Apps *ProjectsAppsService

	Services *ProjectsServicesService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ProjectsServicesBatchUpdateCall

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

func (*ProjectsServicesBatchUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsServicesBatchUpdateCall) Do

Do executes the "firebaseappcheck.projects.services.batchUpdate" call. Exactly one of *GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesBatchUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsServicesBatchUpdateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsServicesGetCall

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

func (*ProjectsServicesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsServicesGetCall) Do

Do executes the "firebaseappcheck.projects.services.get" call. Exactly one of *GoogleFirebaseAppcheckV1betaService or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaService.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsServicesGetCall) Header

func (c *ProjectsServicesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsServicesGetCall) IfNoneMatch

func (c *ProjectsServicesGetCall) IfNoneMatch(entityTag string) *ProjectsServicesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsServicesListCall

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

func (*ProjectsServicesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsServicesListCall) Do

Do executes the "firebaseappcheck.projects.services.list" call. Exactly one of *GoogleFirebaseAppcheckV1betaListServicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaListServicesResponse.ServerResponse.Heade r or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsServicesListCall) Header

func (c *ProjectsServicesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsServicesListCall) IfNoneMatch

func (c *ProjectsServicesListCall) IfNoneMatch(entityTag string) *ProjectsServicesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsServicesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Services to return in the response. Only explicitly configured services are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

func (*ProjectsServicesListCall) PageToken

func (c *ProjectsServicesListCall) PageToken(pageToken string) *ProjectsServicesListCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to ListServices indicating where in the set of Services to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListServices must match the call that provided the page token; if they do not match, the result is undefined.

func (*ProjectsServicesListCall) 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.

type ProjectsServicesPatchCall

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

func (*ProjectsServicesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsServicesPatchCall) Do

Do executes the "firebaseappcheck.projects.services.patch" call. Exactly one of *GoogleFirebaseAppcheckV1betaService or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaService.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsServicesPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsServicesPatchCall) UpdateMask

func (c *ProjectsServicesPatchCall) UpdateMask(updateMask string) *ProjectsServicesPatchCall

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.

type ProjectsServicesService

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

func NewProjectsServicesService

func NewProjectsServicesService(s *Service) *ProjectsServicesService

func (*ProjectsServicesService) BatchUpdate

func (r *ProjectsServicesService) BatchUpdate(parent string, googlefirebaseappcheckv1betabatchupdateservicesrequest *GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest) *ProjectsServicesBatchUpdateCall

BatchUpdate: Updates the specified Service configurations atomically.

  • parent: The parent project name shared by all Service configurations being updated, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.

func (*ProjectsServicesService) Get

Get: Gets the Service configuration for the specified service name.

  • name: The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database).

func (*ProjectsServicesService) List

List: Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.

  • parent: The relative resource name of the parent project for which to list each associated Service, in the format: ``` projects/{project_number} ```.

func (*ProjectsServicesService) Patch

func (r *ProjectsServicesService) Patch(name string, googlefirebaseappcheckv1betaservice *GoogleFirebaseAppcheckV1betaService) *ProjectsServicesPatchCall

Patch: Updates the specified Service configuration.

  • name: The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database).

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Jwks *JwksService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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.

func NewService

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

NewService creates a new Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL