firebaserules

package
v0.204.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package firebaserules provides access to the Firebase Rules API.

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any 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/firebaserules/v1"
...
ctx := context.Background()
firebaserulesService, err := firebaserules.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 google.golang.org/api/option.WithScopes: 

firebaserulesService, err := firebaserules.NewService(ctx, option.WithScopes(firebaserules.FirebaseReadonlyScope))

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

firebaserulesService, err := firebaserules.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

See google.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 settings
	FirebaseScope = "https://www.googleapis.com/auth/firebase"

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Arg 

type Arg struct {
	// AnyValue: Argument matches any value provided.
	AnyValue *Empty `json:"anyValue,omitempty"`
	// ExactValue: Argument exactly matches value provided.
	ExactValue interface{} `json:"exactValue,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AnyValue") 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. "AnyValue") 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:"-"`
}

Arg: Arg matchers for the mock function.

func (Arg) MarshalJSON 

func (s Arg) MarshalJSON() ([]byte, error)

type Empty 

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 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); }

type ExpressionReport added in v0.15.0 

type ExpressionReport struct {
	// Children: Subexpressions
	Children []*ExpressionReport `json:"children,omitempty"`
	// SourcePosition: Position of expression in original rules source.
	SourcePosition *SourcePosition `json:"sourcePosition,omitempty"`
	// Values: Values that this expression evaluated to when encountered.
	Values []*ValueCount `json:"values,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Children") 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. "Children") 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:"-"`
}

ExpressionReport: Describes where in a file an expression is found and what it was evaluated to over the course of its use.

func (ExpressionReport) MarshalJSON added in v0.15.0 

func (s ExpressionReport) MarshalJSON() ([]byte, error)

type File 

type File struct {
	// Content: Required. Textual Content.
	Content string `json:"content,omitempty"`
	// Fingerprint: Fingerprint (e.g. github sha) associated with the `File`.
	Fingerprint string `json:"fingerprint,omitempty"`
	// Name: Required. File name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Content") 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. "Content") 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:"-"`
}

File: `File` containing source content.

func (File) MarshalJSON 

func (s File) MarshalJSON() ([]byte, error)

type FunctionCall 

type FunctionCall struct {
	// Args: The arguments that were provided to the function.
	Args []interface{} `json:"args,omitempty"`
	// Function: Name of the function invoked.
	Function string `json:"function,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") 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. "Args") 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:"-"`
}

FunctionCall: Represents a service-defined function call that was invoked during test execution.

func (FunctionCall) MarshalJSON 

func (s FunctionCall) MarshalJSON() ([]byte, error)

type FunctionMock 

type FunctionMock struct {
	// Args: The list of `Arg` values to match. The order in which the arguments
	// are provided is the order in which they must appear in the function
	// invocation.
	Args []*Arg `json:"args,omitempty"`
	// Function: The name of the function. The function name must match one
	// provided by a service declaration.
	Function string `json:"function,omitempty"`
	// Result: The mock result of the function call.
	Result *Result `json:"result,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") 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. "Args") 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:"-"`
}

FunctionMock: Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`.

func (FunctionMock) MarshalJSON 

func (s FunctionMock) MarshalJSON() ([]byte, error)

type GetReleaseExecutableResponse 

type GetReleaseExecutableResponse struct {
	// Executable: Executable view of the `Ruleset` referenced by the `Release`.
	Executable string `json:"executable,omitempty"`
	// ExecutableVersion: The Rules runtime version of the executable.
	//
	// Possible values:
	//   "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED" - Executable format unspecified.
	// Defaults to FIREBASE_RULES_EXECUTABLE_V1
	//   "FIREBASE_RULES_EXECUTABLE_V1" - Firebase Rules syntax 'rules2' executable
	// versions: Custom AST for use with Java clients.
	//   "FIREBASE_RULES_EXECUTABLE_V2" - CEL-based executable for use with C++
	// clients.
	ExecutableVersion string `json:"executableVersion,omitempty"`
	// Language: `Language` used to generate the executable bytes.
	//
	// Possible values:
	//   "LANGUAGE_UNSPECIFIED" - Language unspecified. Defaults to FIREBASE_RULES.
	//   "FIREBASE_RULES" - Firebase Rules language.
	//   "EVENT_FLOW_TRIGGERS" - Event Flow triggers.
	Language string `json:"language,omitempty"`
	// RulesetName: `Ruleset` name associated with the `Release` executable.
	RulesetName string `json:"rulesetName,omitempty"`
	// SyncTime: Optional, indicates the freshness of the result. The response is
	// guaranteed to be the latest within an interval up to the sync_time
	// (inclusive).
	SyncTime string `json:"syncTime,omitempty"`
	// UpdateTime: Timestamp for the most recent `Release.update_time`.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Executable") 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. "Executable") 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:"-"`
}

GetReleaseExecutableResponse: The response for FirebaseRulesService.GetReleaseExecutable

func (GetReleaseExecutableResponse) MarshalJSON 

func (s GetReleaseExecutableResponse) MarshalJSON() ([]byte, error)

type Issue 

type Issue struct {
	// Description: Short error description.
	Description string `json:"description,omitempty"`
	// Severity: The severity of the issue.
	//
	// Possible values:
	//   "SEVERITY_UNSPECIFIED" - An unspecified severity.
	//   "DEPRECATION" - Deprecation issue for statements and method that may no
	// longer be supported or maintained.
	//   "WARNING" - Warnings such as: unused variables.
	//   "ERROR" - Errors such as: unmatched curly braces or variable redefinition.
	Severity string `json:"severity,omitempty"`
	// SourcePosition: Position of the issue in the `Source`.
	SourcePosition *SourcePosition `json:"sourcePosition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`
}

Issue: Issues include warnings, errors, and deprecation notices.

func (Issue) MarshalJSON 

func (s Issue) MarshalJSON() ([]byte, error)

type ListReleasesResponse 

type ListReleasesResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of results. If
	// the value is empty, no further results remain.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Releases: List of `Release` instances.
	Releases []*Release `json:"releases,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 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. "NextPageToken") 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:"-"`
}

ListReleasesResponse: The response for FirebaseRulesService.ListReleases.

func (ListReleasesResponse) MarshalJSON 

func (s ListReleasesResponse) MarshalJSON() ([]byte, error)

type ListRulesetsResponse 

type ListRulesetsResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of results. If
	// the value is empty, no further results remain.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Rulesets: List of `Ruleset` instances.
	Rulesets []*Ruleset `json:"rulesets,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 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. "NextPageToken") 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:"-"`
}

ListRulesetsResponse: The response for FirebaseRulesService.ListRulesets.

func (ListRulesetsResponse) MarshalJSON 

func (s ListRulesetsResponse) MarshalJSON() ([]byte, error)

type Metadata added in v0.15.0 

type Metadata struct {
	// Services: Services that this ruleset has declarations for (e.g.,
	// "cloud.firestore"). There may be 0+ of these.
	Services []string `json:"services,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Services") 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. "Services") 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:"-"`
}

Metadata: Metadata for a Ruleset.

func (Metadata) MarshalJSON added in v0.15.0 

func (s Metadata) MarshalJSON() ([]byte, error)

type ProjectsReleasesCreateCall 

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

func (*ProjectsReleasesCreateCall) Context 

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

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

func (*ProjectsReleasesCreateCall) Do 

func (c *ProjectsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebaserules.projects.releases.create" call. Any non-2xx status code is an error. Response headers are in either *Release.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 (*ProjectsReleasesCreateCall) Fields 

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

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

func (*ProjectsReleasesCreateCall) Header 

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

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

type ProjectsReleasesDeleteCall 

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

func (*ProjectsReleasesDeleteCall) Context 

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

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

func (*ProjectsReleasesDeleteCall) Do 

func (c *ProjectsReleasesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebaserules.projects.releases.delete" 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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsReleasesDeleteCall) Fields 

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

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

func (*ProjectsReleasesDeleteCall) Header 

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

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

type ProjectsReleasesGetCall 

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

func (*ProjectsReleasesGetCall) Context 

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

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

func (*ProjectsReleasesGetCall) Do 

func (c *ProjectsReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebaserules.projects.releases.get" call. Any non-2xx status code is an error. Response headers are in either *Release.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 (*ProjectsReleasesGetCall) Fields 

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

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

func (*ProjectsReleasesGetCall) Header 

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

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

func (*ProjectsReleasesGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ProjectsReleasesGetExecutableCall 

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

func (*ProjectsReleasesGetExecutableCall) Context 

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

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

func (*ProjectsReleasesGetExecutableCall) Do 

func (c *ProjectsReleasesGetExecutableCall) Do(opts ...googleapi.CallOption) (*GetReleaseExecutableResponse, error)

Do executes the "firebaserules.projects.releases.getExecutable" call. Any non-2xx status code is an error. Response headers are in either *GetReleaseExecutableResponse.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 (*ProjectsReleasesGetExecutableCall) ExecutableVersion 

func (c *ProjectsReleasesGetExecutableCall) ExecutableVersion(executableVersion string) *ProjectsReleasesGetExecutableCall

ExecutableVersion sets the optional parameter "executableVersion": The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.

Possible values: 

"RELEASE_EXECUTABLE_VERSION_UNSPECIFIED" - Executable format unspecified.

Defaults to FIREBASE_RULES_EXECUTABLE_V1 

"FIREBASE_RULES_EXECUTABLE_V1" - Firebase Rules syntax 'rules2' executable

versions: Custom AST for use with Java clients. 

"FIREBASE_RULES_EXECUTABLE_V2" - CEL-based executable for use with C++

clients.

func (*ProjectsReleasesGetExecutableCall) Fields 

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

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

func (*ProjectsReleasesGetExecutableCall) Header 

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

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

func (*ProjectsReleasesGetExecutableCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ProjectsReleasesListCall 

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

func (*ProjectsReleasesListCall) Context 

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

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

func (*ProjectsReleasesListCall) Do 

func (c *ProjectsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)

Do executes the "firebaserules.projects.releases.list" call. Any non-2xx status code is an error. Response headers are in either *ListReleasesResponse.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 (*ProjectsReleasesListCall) Fields 

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

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

func (*ProjectsReleasesListCall) Filter 

func (c *ProjectsReleasesListCall) Filter(filter string) *ProjectsReleasesListCall

Filter sets the optional parameter "filter": `Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.ruleset_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -> projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.

func (*ProjectsReleasesListCall) Header 

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

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

func (*ProjectsReleasesListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*ProjectsReleasesListCall) PageSize 

func (c *ProjectsReleasesListCall) PageSize(pageSize int64) *ProjectsReleasesListCall

PageSize sets the optional parameter "pageSize": Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.

func (*ProjectsReleasesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": Next page token for the next batch of `Release` instances.

func (*ProjectsReleasesListCall) Pages 

func (c *ProjectsReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error

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 ProjectsReleasesPatchCall 

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

func (*ProjectsReleasesPatchCall) Context 

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

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

func (*ProjectsReleasesPatchCall) Do 

func (c *ProjectsReleasesPatchCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebaserules.projects.releases.patch" call. Any non-2xx status code is an error. Response headers are in either *Release.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 (*ProjectsReleasesPatchCall) Fields 

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

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

func (*ProjectsReleasesPatchCall) Header 

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

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

type ProjectsReleasesService 

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

func NewProjectsReleasesService 

func NewProjectsReleasesService(s *Service) *ProjectsReleasesService

func (*ProjectsReleasesService) Create 

func (r *ProjectsReleasesService) Create(name string, release *Release) *ProjectsReleasesCreateCall

Create: Create a `Release`. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a `Release` refers to a `Ruleset`, the rules can be enforced by Firebase Rules-enabled services. More than one `Release` may be 'live' concurrently. Consider the following three `Release` names for `projects/foo` and the `Ruleset` to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a `Ruleset` rollout in progress. The `prod` and `prod/beta` releases refer to the same `Ruleset`. However, `prod/v23` refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be updated using the UpdateRelease method.

  • name: Resource name for the project which owns this `Release`. Format: `projects/{project_id}`.

func (*ProjectsReleasesService) Delete 

func (r *ProjectsReleasesService) Delete(name string) *ProjectsReleasesDeleteCall

Delete: Delete a `Release` by resource name.

  • name: Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_id}`.

func (*ProjectsReleasesService) Get 

func (r *ProjectsReleasesService) Get(name string) *ProjectsReleasesGetCall

Get: Get a `Release` by name.

  • name: Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}`.

func (*ProjectsReleasesService) GetExecutable 

func (r *ProjectsReleasesService) GetExecutable(name string) *ProjectsReleasesGetExecutableCall

GetExecutable: Get the `Release` executable to use when enforcing rules.

  • name: Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}`.

func (*ProjectsReleasesService) List 

func (r *ProjectsReleasesService) List(name string) *ProjectsReleasesListCall

List: List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.

- name: Resource name for the project. Format: `projects/{project_id}`.

func (*ProjectsReleasesService) Patch 

func (r *ProjectsReleasesService) Patch(name string, updatereleaserequest *UpdateReleaseRequest) *ProjectsReleasesPatchCall

Patch: Update a `Release` via PATCH. Only updates to `ruleset_name` will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.

  • name: Resource name for the project which owns this `Release`. Format: `projects/{project_id}`.

type ProjectsRulesetsCreateCall 

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

func (*ProjectsRulesetsCreateCall) Context 

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

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

func (*ProjectsRulesetsCreateCall) Do 

func (c *ProjectsRulesetsCreateCall) Do(opts ...googleapi.CallOption) (*Ruleset, error)

Do executes the "firebaserules.projects.rulesets.create" call. Any non-2xx status code is an error. Response headers are in either *Ruleset.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 (*ProjectsRulesetsCreateCall) Fields 

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

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

func (*ProjectsRulesetsCreateCall) Header 

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

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

type ProjectsRulesetsDeleteCall 

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

func (*ProjectsRulesetsDeleteCall) Context 

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

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

func (*ProjectsRulesetsDeleteCall) Do 

func (c *ProjectsRulesetsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebaserules.projects.rulesets.delete" 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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsRulesetsDeleteCall) Fields 

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

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

func (*ProjectsRulesetsDeleteCall) Header 

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

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

type ProjectsRulesetsGetCall 

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

func (*ProjectsRulesetsGetCall) Context 

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

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

func (*ProjectsRulesetsGetCall) Do 

func (c *ProjectsRulesetsGetCall) Do(opts ...googleapi.CallOption) (*Ruleset, error)

Do executes the "firebaserules.projects.rulesets.get" call. Any non-2xx status code is an error. Response headers are in either *Ruleset.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 (*ProjectsRulesetsGetCall) Fields 

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

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

func (*ProjectsRulesetsGetCall) Header 

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

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

func (*ProjectsRulesetsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ProjectsRulesetsListCall 

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

func (*ProjectsRulesetsListCall) Context 

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

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

func (*ProjectsRulesetsListCall) Do 

func (c *ProjectsRulesetsListCall) Do(opts ...googleapi.CallOption) (*ListRulesetsResponse, error)

Do executes the "firebaserules.projects.rulesets.list" call. Any non-2xx status code is an error. Response headers are in either *ListRulesetsResponse.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 (*ProjectsRulesetsListCall) Fields 

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

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

func (*ProjectsRulesetsListCall) Filter 

func (c *ProjectsRulesetsListCall) Filter(filter string) *ProjectsRulesetsListCall

Filter sets the optional parameter "filter": `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`

func (*ProjectsRulesetsListCall) Header 

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

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

func (*ProjectsRulesetsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*ProjectsRulesetsListCall) PageSize 

func (c *ProjectsRulesetsListCall) PageSize(pageSize int64) *ProjectsRulesetsListCall

PageSize sets the optional parameter "pageSize": Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.

func (*ProjectsRulesetsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": Next page token for loading the next batch of `Ruleset` instances.

func (*ProjectsRulesetsListCall) Pages 

func (c *ProjectsRulesetsListCall) Pages(ctx context.Context, f func(*ListRulesetsResponse) error) error

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 ProjectsRulesetsService 

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

func NewProjectsRulesetsService 

func NewProjectsRulesetsService(s *Service) *ProjectsRulesetsService

func (*ProjectsRulesetsService) Create 

func (r *ProjectsRulesetsService) Create(name string, ruleset *Ruleset) *ProjectsRulesetsCreateCall

Create: Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.

  • name: Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}`.

func (*ProjectsRulesetsService) Delete 

func (r *ProjectsRulesetsService) Delete(name string) *ProjectsRulesetsDeleteCall

Delete: Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.

  • name: Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}`.

func (*ProjectsRulesetsService) Get 

func (r *ProjectsRulesetsService) Get(name string) *ProjectsRulesetsGetCall

Get: Get a `Ruleset` by name including the full `Source` contents.

  • name: Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}`.

func (*ProjectsRulesetsService) List 

func (r *ProjectsRulesetsService) List(name string) *ProjectsRulesetsListCall

List: List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.

- name: Resource name for the project. Format: `projects/{project_id}`.

type ProjectsService 

type ProjectsService struct {
	Releases *ProjectsReleasesService

	Rulesets *ProjectsRulesetsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) Test 

func (r *ProjectsService) Test(name string, testrulesetrequest *TestRulesetRequest) *ProjectsTestCall

Test: Test `Source` for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with `Source` or a `Ruleset` name. Passing `Source` is useful for unit testing new rules. Passing a `Ruleset` name is useful for regression testing an existing rule. The following is an example of `Source` that permits users to upload images to a bucket bearing their user id and matching the correct metadata: _*Example*_ // Users are allowed to subscribe and unsubscribe to the blog. service firebase.storage { match /users/{userId}/images/{imageName} { allow write: if userId == request.auth.uid && (imageName.matches('*.png$') || imageName.matches('*.jpg$')) && resource.mimeType.matches('^image/') } }

  • name: Tests may either provide `source` or a `Ruleset` resource name. For tests against `source`, the resource name must refer to the project: Format: `projects/{project_id}` For tests against a `Ruleset`, this must be the `Ruleset` resource name: Format: `projects/{project_id}/rulesets/{ruleset_id}`.

type ProjectsTestCall 

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

func (*ProjectsTestCall) Context 

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

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

func (*ProjectsTestCall) Do 

func (c *ProjectsTestCall) Do(opts ...googleapi.CallOption) (*TestRulesetResponse, error)

Do executes the "firebaserules.projects.test" call. Any non-2xx status code is an error. Response headers are in either *TestRulesetResponse.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 (*ProjectsTestCall) Fields 

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

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

func (*ProjectsTestCall) Header 

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

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

type Release 

type Release struct {
	// CreateTime: Output only. Time the release was created.
	CreateTime string `json:"createTime,omitempty"`
	// Name: Required. Format: `projects/{project_id}/releases/{release_id}`
	Name string `json:"name,omitempty"`
	// RulesetName: Required. Name of the `Ruleset` referred to by this `Release`.
	// The `Ruleset` must exist for the `Release` to be created.
	RulesetName string `json:"rulesetName,omitempty"`
	// UpdateTime: Output only. Time the release was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

Release: `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.

func (Release) MarshalJSON 

func (s Release) MarshalJSON() ([]byte, error)

type Result 

type Result struct {
	// Undefined: The result is undefined, meaning the result could not be
	// computed.
	Undefined *Empty `json:"undefined,omitempty"`
	// Value: The result is an actual value. The type of the value must match that
	// of the type declared by the service.
	Value interface{} `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Undefined") 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. "Undefined") 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:"-"`
}

Result: Possible result values from the function mock invocation.

func (Result) MarshalJSON 

func (s Result) MarshalJSON() ([]byte, error)

type Ruleset 

type Ruleset struct {
	// AttachmentPoint: Immutable. Intended resource to which this Ruleset should
	// be released. May be left blank to signify the resource associated with the
	// default release. Expected format:
	// firestore.googleapis.com/projects//databases/
	AttachmentPoint string `json:"attachmentPoint,omitempty"`
	// CreateTime: Output only. Time the `Ruleset` was created.
	CreateTime string `json:"createTime,omitempty"`
	// Metadata: Output only. The metadata for this ruleset.
	Metadata *Metadata `json:"metadata,omitempty"`
	// Name: Output only. Name of the `Ruleset`. The ruleset_id is auto generated
	// by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
	Name string `json:"name,omitempty"`
	// Source: Required. `Source` for the `Ruleset`.
	Source *Source `json:"source,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AttachmentPoint") 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. "AttachmentPoint") 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:"-"`
}

Ruleset: `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.

func (Ruleset) MarshalJSON 

func (s Ruleset) MarshalJSON() ([]byte, error)

type Service 

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

	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 added in v0.3.0 

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

NewService creates a new Service.

type Source 

type Source struct {
	// Files: Required. `File` set constituting the `Source` bundle.
	Files []*File `json:"files,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Files") 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. "Files") 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:"-"`
}

Source: `Source` is one or more `File` messages comprising a logical set of rules.

func (Source) MarshalJSON 

func (s Source) MarshalJSON() ([]byte, error)

type SourcePosition 

type SourcePosition struct {
	// Column: First column on the source line associated with the source fragment.
	Column int64 `json:"column,omitempty"`
	// CurrentOffset: Start position relative to the beginning of the file.
	CurrentOffset int64 `json:"currentOffset,omitempty"`
	// EndOffset: End position relative to the beginning of the file.
	EndOffset int64 `json:"endOffset,omitempty"`
	// FileName: Name of the `File`.
	FileName string `json:"fileName,omitempty"`
	// Line: Line number of the source fragment. 1-based.
	Line int64 `json:"line,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Column") 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. "Column") 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:"-"`
}

SourcePosition: Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes.

func (SourcePosition) MarshalJSON 

func (s SourcePosition) MarshalJSON() ([]byte, error)

type TestCase 

type TestCase struct {
	// Expectation: Test expectation.
	//
	// Possible values:
	//   "EXPECTATION_UNSPECIFIED" - Unspecified expectation.
	//   "ALLOW" - Expect an allowed result.
	//   "DENY" - Expect a denied result.
	Expectation string `json:"expectation,omitempty"`
	// ExpressionReportLevel: Specifies what should be included in the response.
	//
	// Possible values:
	//   "LEVEL_UNSPECIFIED" - No level has been specified. Defaults to "NONE"
	// behavior.
	//   "NONE" - Do not include any additional information.
	//   "FULL" - Include detailed reporting on expressions evaluated.
	//   "VISITED" - Only include the expressions that were visited during
	// evaluation.
	ExpressionReportLevel string `json:"expressionReportLevel,omitempty"`
	// FunctionMocks: Optional function mocks for service-defined functions. If not
	// set, any service defined function is expected to return an error, which may
	// or may not influence the test outcome.
	FunctionMocks []*FunctionMock `json:"functionMocks,omitempty"`
	// PathEncoding: Specifies whether paths (such as request.path) are encoded and
	// how.
	//
	// Possible values:
	//   "ENCODING_UNSPECIFIED" - No encoding has been specified. Defaults to
	// "URL_ENCODED" behavior.
	//   "URL_ENCODED" - Treats path segments as URL encoded but with non-encoded
	// separators ("/"). This is the default behavior.
	//   "PLAIN" - Treats total path as non-URL encoded e.g. raw.
	PathEncoding string `json:"pathEncoding,omitempty"`
	// Request: Request context. The exact format of the request context is
	// service-dependent. See the appropriate service documentation for information
	// about the supported fields and types on the request. Minimally, all services
	// support the following fields and types: Request field | Type
	// ---------------|----------------- auth.uid | `string` auth.token | `map`
	// headers | `map` method | `string` params | `map` path | `string` time |
	// `google.protobuf.Timestamp` If the request value is not well-formed for the
	// service, the request will be rejected as an invalid argument.
	Request interface{} `json:"request,omitempty"`
	// Resource: Optional resource value as it appears in persistent storage before
	// the request is fulfilled. The resource type depends on the `request.path`
	// value.
	Resource interface{} `json:"resource,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Expectation") 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. "Expectation") 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:"-"`
}

TestCase: `TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed.

func (TestCase) MarshalJSON 

func (s TestCase) MarshalJSON() ([]byte, error)

type TestResult 

type TestResult struct {
	// DebugMessages: Debug messages related to test execution issues encountered
	// during evaluation. Debug messages may be related to too many or too few
	// invocations of function mocks or to runtime errors that occur during
	// evaluation. For example: “`Unable to read variable [name: "resource"]“`
	DebugMessages []string `json:"debugMessages,omitempty"`
	// ErrorPosition: Position in the `Source` or `Ruleset` where the principle
	// runtime error occurs. Evaluation of an expression may result in an error.
	// Rules are deny by default, so a `DENY` expectation when an error is
	// generated is valid. When there is a `DENY` with an error, the
	// `SourcePosition` is returned. E.g. `error_position { line: 19 column: 37 }`
	ErrorPosition *SourcePosition `json:"errorPosition,omitempty"`
	// ExpressionReports: The mapping from expression in the ruleset AST to the
	// values they were evaluated to. Partially-nested to mirror AST structure.
	// Note that this field is actually tracking expressions and not permission
	// statements in contrast to the "visited_expressions" field above. Literal
	// expressions are omitted.
	ExpressionReports []*ExpressionReport `json:"expressionReports,omitempty"`
	// FunctionCalls: The set of function calls made to service-defined methods.
	// Function calls are included in the order in which they are encountered
	// during evaluation, are provided for both mocked and unmocked functions, and
	// included on the response regardless of the test `state`.
	FunctionCalls []*FunctionCall `json:"functionCalls,omitempty"`
	// State: State of the test.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Test state is not set.
	//   "SUCCESS" - Test is a success.
	//   "FAILURE" - Test is a failure.
	State string `json:"state,omitempty"`
	// VisitedExpressions: The set of visited permission expressions for a given
	// test. This returns the positions and evaluation results of all visited
	// permission expressions which were relevant to the test case, e.g. “` match
	// /path { allow read if: } “` For a detailed report of the intermediate
	// evaluation states, see the `expression_reports` field
	VisitedExpressions []*VisitedExpression `json:"visitedExpressions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DebugMessages") 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. "DebugMessages") 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:"-"`
}

TestResult: Test result message containing the state of the test as well as a description and source position for test failures.

func (TestResult) MarshalJSON 

func (s TestResult) MarshalJSON() ([]byte, error)

type TestRulesetRequest 

type TestRulesetRequest struct {
	// Source: Optional `Source` to be checked for correctness. This field must not
	// be set when the resource name refers to a `Ruleset`.
	Source *Source `json:"source,omitempty"`
	// TestSuite: The tests to execute against the `Source`. When `Source` is
	// provided inline, the test cases will only be run if the `Source` is
	// syntactically and semantically valid. Inline `TestSuite` to run.
	TestSuite *TestSuite `json:"testSuite,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Source") 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. "Source") 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:"-"`
}

TestRulesetRequest: The request for FirebaseRulesService.TestRuleset.

func (TestRulesetRequest) MarshalJSON 

func (s TestRulesetRequest) MarshalJSON() ([]byte, error)

type TestRulesetResponse 

type TestRulesetResponse struct {
	// Issues: Syntactic and semantic `Source` issues of varying severity. Issues
	// of `ERROR` severity will prevent tests from executing.
	Issues []*Issue `json:"issues,omitempty"`
	// TestResults: The set of test results given the test cases in the
	// `TestSuite`. The results will appear in the same order as the test cases
	// appear in the `TestSuite`.
	TestResults []*TestResult `json:"testResults,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Issues") 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. "Issues") 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:"-"`
}

TestRulesetResponse: The response for FirebaseRulesService.TestRuleset.

func (TestRulesetResponse) MarshalJSON 

func (s TestRulesetResponse) MarshalJSON() ([]byte, error)

type TestSuite 

type TestSuite struct {
	// TestCases: Collection of test cases associated with the `TestSuite`.
	TestCases []*TestCase `json:"testCases,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TestCases") 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. "TestCases") 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:"-"`
}

TestSuite: `TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check.

func (TestSuite) MarshalJSON 

func (s TestSuite) MarshalJSON() ([]byte, error)

type UpdateReleaseRequest 

type UpdateReleaseRequest struct {
	// Release: Required. `Release` to update.
	Release *Release `json:"release,omitempty"`
	// UpdateMask: Specifies which fields to update.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Release") 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. "Release") 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:"-"`
}

UpdateReleaseRequest: The request for FirebaseRulesService.UpdateRelease.

func (UpdateReleaseRequest) MarshalJSON 

func (s UpdateReleaseRequest) MarshalJSON() ([]byte, error)

type ValueCount added in v0.15.0 

type ValueCount struct {
	// Count: The amount of times that expression returned.
	Count int64 `json:"count,omitempty"`
	// Value: The return value of the expression
	Value interface{} `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

ValueCount: Tuple for how many times an Expression was evaluated to a particular ExpressionValue.

func (ValueCount) MarshalJSON added in v0.15.0 

func (s ValueCount) MarshalJSON() ([]byte, error)

type VisitedExpression 

type VisitedExpression struct {
	// SourcePosition: Position in the `Source` or `Ruleset` where an expression
	// was visited.
	SourcePosition *SourcePosition `json:"sourcePosition,omitempty"`
	// Value: The evaluated value for the visited expression, e.g. true/false
	Value interface{} `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SourcePosition") 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. "SourcePosition") 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:"-"`
}

VisitedExpression: Store the position and access outcome for an expression visited in rules.

func (VisitedExpression) MarshalJSON 

func (s VisitedExpression) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.