firebaserules - ActiveState ActiveGo 1.8
...

Package firebaserules

import "google.golang.org/api/firebaserules/v1"
Overview
Index

Overview ▾

Package firebaserules provides access to the Firebase Rules API.

See https://firebase.google.com/docs/storage/security

Usage example:

import "google.golang.org/api/firebaserules/v1"
...
firebaserulesService, err := firebaserules.New(oauthHttpClient)

Index ▾

Constants
type Arg
    func (s *Arg) MarshalJSON() ([]byte, error)
type Empty
type File
    func (s *File) MarshalJSON() ([]byte, error)
type FunctionCall
    func (s *FunctionCall) MarshalJSON() ([]byte, error)
type FunctionMock
    func (s *FunctionMock) MarshalJSON() ([]byte, error)
type Issue
    func (s *Issue) MarshalJSON() ([]byte, error)
type ListReleasesResponse
    func (s *ListReleasesResponse) MarshalJSON() ([]byte, error)
type ListRulesetsResponse
    func (s *ListRulesetsResponse) MarshalJSON() ([]byte, error)
type ProjectsReleasesCreateCall
    func (c *ProjectsReleasesCreateCall) Context(ctx context.Context) *ProjectsReleasesCreateCall
    func (c *ProjectsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)
    func (c *ProjectsReleasesCreateCall) Fields(s ...googleapi.Field) *ProjectsReleasesCreateCall
    func (c *ProjectsReleasesCreateCall) Header() http.Header
type ProjectsReleasesDeleteCall
    func (c *ProjectsReleasesDeleteCall) Context(ctx context.Context) *ProjectsReleasesDeleteCall
    func (c *ProjectsReleasesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
    func (c *ProjectsReleasesDeleteCall) Fields(s ...googleapi.Field) *ProjectsReleasesDeleteCall
    func (c *ProjectsReleasesDeleteCall) Header() http.Header
type ProjectsReleasesGetCall
    func (c *ProjectsReleasesGetCall) Context(ctx context.Context) *ProjectsReleasesGetCall
    func (c *ProjectsReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)
    func (c *ProjectsReleasesGetCall) Fields(s ...googleapi.Field) *ProjectsReleasesGetCall
    func (c *ProjectsReleasesGetCall) Header() http.Header
    func (c *ProjectsReleasesGetCall) IfNoneMatch(entityTag string) *ProjectsReleasesGetCall
type ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) Context(ctx context.Context) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)
    func (c *ProjectsReleasesListCall) Fields(s ...googleapi.Field) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) Filter(filter string) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) Header() http.Header
    func (c *ProjectsReleasesListCall) IfNoneMatch(entityTag string) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) PageSize(pageSize int64) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) PageToken(pageToken string) *ProjectsReleasesListCall
    func (c *ProjectsReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error
type ProjectsReleasesService
    func NewProjectsReleasesService(s *Service) *ProjectsReleasesService
    func (r *ProjectsReleasesService) Create(name string, release *Release) *ProjectsReleasesCreateCall
    func (r *ProjectsReleasesService) Delete(name string) *ProjectsReleasesDeleteCall
    func (r *ProjectsReleasesService) Get(name string) *ProjectsReleasesGetCall
    func (r *ProjectsReleasesService) List(name string) *ProjectsReleasesListCall
    func (r *ProjectsReleasesService) Update(name string, release *Release) *ProjectsReleasesUpdateCall
type ProjectsReleasesUpdateCall
    func (c *ProjectsReleasesUpdateCall) Context(ctx context.Context) *ProjectsReleasesUpdateCall
    func (c *ProjectsReleasesUpdateCall) Do(opts ...googleapi.CallOption) (*Release, error)
    func (c *ProjectsReleasesUpdateCall) Fields(s ...googleapi.Field) *ProjectsReleasesUpdateCall
    func (c *ProjectsReleasesUpdateCall) Header() http.Header
type ProjectsRulesetsCreateCall
    func (c *ProjectsRulesetsCreateCall) Context(ctx context.Context) *ProjectsRulesetsCreateCall
    func (c *ProjectsRulesetsCreateCall) Do(opts ...googleapi.CallOption) (*Ruleset, error)
    func (c *ProjectsRulesetsCreateCall) Fields(s ...googleapi.Field) *ProjectsRulesetsCreateCall
    func (c *ProjectsRulesetsCreateCall) Header() http.Header
type ProjectsRulesetsDeleteCall
    func (c *ProjectsRulesetsDeleteCall) Context(ctx context.Context) *ProjectsRulesetsDeleteCall
    func (c *ProjectsRulesetsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
    func (c *ProjectsRulesetsDeleteCall) Fields(s ...googleapi.Field) *ProjectsRulesetsDeleteCall
    func (c *ProjectsRulesetsDeleteCall) Header() http.Header
type ProjectsRulesetsGetCall
    func (c *ProjectsRulesetsGetCall) Context(ctx context.Context) *ProjectsRulesetsGetCall
    func (c *ProjectsRulesetsGetCall) Do(opts ...googleapi.CallOption) (*Ruleset, error)
    func (c *ProjectsRulesetsGetCall) Fields(s ...googleapi.Field) *ProjectsRulesetsGetCall
    func (c *ProjectsRulesetsGetCall) Header() http.Header
    func (c *ProjectsRulesetsGetCall) IfNoneMatch(entityTag string) *ProjectsRulesetsGetCall
type ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) Context(ctx context.Context) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) Do(opts ...googleapi.CallOption) (*ListRulesetsResponse, error)
    func (c *ProjectsRulesetsListCall) Fields(s ...googleapi.Field) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) Filter(filter string) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) Header() http.Header
    func (c *ProjectsRulesetsListCall) IfNoneMatch(entityTag string) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) PageSize(pageSize int64) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) PageToken(pageToken string) *ProjectsRulesetsListCall
    func (c *ProjectsRulesetsListCall) Pages(ctx context.Context, f func(*ListRulesetsResponse) error) error
type ProjectsRulesetsService
    func NewProjectsRulesetsService(s *Service) *ProjectsRulesetsService
    func (r *ProjectsRulesetsService) Create(name string, ruleset *Ruleset) *ProjectsRulesetsCreateCall
    func (r *ProjectsRulesetsService) Delete(name string) *ProjectsRulesetsDeleteCall
    func (r *ProjectsRulesetsService) Get(name string) *ProjectsRulesetsGetCall
    func (r *ProjectsRulesetsService) List(name string) *ProjectsRulesetsListCall
type ProjectsService
    func NewProjectsService(s *Service) *ProjectsService
    func (r *ProjectsService) Test(name string, testrulesetrequest *TestRulesetRequest) *ProjectsTestCall
type ProjectsTestCall
    func (c *ProjectsTestCall) Context(ctx context.Context) *ProjectsTestCall
    func (c *ProjectsTestCall) Do(opts ...googleapi.CallOption) (*TestRulesetResponse, error)
    func (c *ProjectsTestCall) Fields(s ...googleapi.Field) *ProjectsTestCall
    func (c *ProjectsTestCall) Header() http.Header
type Release
    func (s *Release) MarshalJSON() ([]byte, error)
type Result
    func (s *Result) MarshalJSON() ([]byte, error)
type Ruleset
    func (s *Ruleset) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
type Source
    func (s *Source) MarshalJSON() ([]byte, error)
type SourcePosition
    func (s *SourcePosition) MarshalJSON() ([]byte, error)
type TestCase
    func (s *TestCase) MarshalJSON() ([]byte, error)
type TestResult
    func (s *TestResult) MarshalJSON() ([]byte, error)
type TestRulesetRequest
    func (s *TestRulesetRequest) MarshalJSON() ([]byte, error)
type TestRulesetResponse
    func (s *TestRulesetResponse) MarshalJSON() ([]byte, error)
type TestSuite
    func (s *TestSuite) MarshalJSON() ([]byte, error)

Package files

firebaserules-gen.go

Constants

OAuth2 scopes used by this API.

const (
    // View and manage your data across Google Cloud Platform services
    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"
)

type Arg

Arg: Arg matchers for the mock function.

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 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. "AnyValue") 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:"-"`
}

func (*Arg) MarshalJSON

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

type Empty

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

}

The JSON representation for `Empty` is empty JSON object `{}`.

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

type File

File: `File` containing source content.

type File struct {
    // Content: Textual Content.
    Content string `json:"content,omitempty"`

    // Fingerprint: Fingerprint (e.g. github sha) associated with the
    // `File`.
    Fingerprint string `json:"fingerprint,omitempty"`

    // Name: 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 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. "Content") 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:"-"`
}

func (*File) MarshalJSON

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

type FunctionCall

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

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 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. "Args") 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:"-"`
}

func (*FunctionCall) MarshalJSON

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

type FunctionMock

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`.

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 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. "Args") 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:"-"`
}

func (*FunctionMock) MarshalJSON

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

type Issue

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

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 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. "Description") 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:"-"`
}

func (*Issue) MarshalJSON

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

type ListReleasesResponse

ListReleasesResponse: The response for FirebaseRulesService.ListReleases.

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 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:"-"`
}

func (*ListReleasesResponse) MarshalJSON

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

type ListRulesetsResponse

ListRulesetsResponse: The response for FirebaseRulesService.ListRulesets.

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 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:"-"`
}

func (*ListRulesetsResponse) MarshalJSON

func (s *ListRulesetsResponse) 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsReleasesCreateCall) Do

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

Do executes the "firebaserules.projects.releases.create" call. Exactly one of *Release or error will be non-nil. 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 information.

func (*ProjectsReleasesCreateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsReleasesDeleteCall) Do

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

Do executes the "firebaserules.projects.releases.delete" call. Exactly one of *Empty or error will be non-nil. 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 information.

func (*ProjectsReleasesDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsReleasesGetCall) Do

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

Do executes the "firebaserules.projects.releases.get" call. Exactly one of *Release or error will be non-nil. 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 information.

func (*ProjectsReleasesGetCall) Header

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

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

func (*ProjectsReleasesGetCall) IfNoneMatch

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

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 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsReleasesListCall) Do

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

Do executes the "firebaserules.projects.releases.list" call. Exactly one of *ListReleasesResponse or error will be non-nil. 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 information.

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`, `Release.ruleset_name`, and `Release.test_suite_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/release s/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/release s/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. e.g. `test_suite_name=projects/foo/testsuites/uuid1`

func (*ProjectsReleasesListCall) Header

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

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

func (*ProjectsReleasesListCall) IfNoneMatch

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

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 (*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 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/relea ses/prod | projects/foo/rulesets/uuid123 projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123 projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456

The table reflects the `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.

func (*ProjectsReleasesService) Delete

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

Delete: Delete a `Release` by resource name.

func (*ProjectsReleasesService) Get

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

Get: Get a `Release` by name.

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.

func (*ProjectsReleasesService) Update

func (r *ProjectsReleasesService) Update(name string, release *Release) *ProjectsReleasesUpdateCall

Update: Update a `Release`.

Only updates to the `ruleset_name` and `test_suite_name` fields will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.

type ProjectsReleasesUpdateCall

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

func (*ProjectsReleasesUpdateCall) Context

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

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 (*ProjectsReleasesUpdateCall) Do

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

Do executes the "firebaserules.projects.releases.update" call. Exactly one of *Release or error will be non-nil. 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 (*ProjectsReleasesUpdateCall) Fields

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

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

func (*ProjectsReleasesUpdateCall) Header

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

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

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsRulesetsCreateCall) Do

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

Do executes the "firebaserules.projects.rulesets.create" call. Exactly one of *Ruleset or error will be non-nil. 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 information.

func (*ProjectsRulesetsCreateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsRulesetsDeleteCall) Do

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

Do executes the "firebaserules.projects.rulesets.delete" call. Exactly one of *Empty or error will be non-nil. 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 information.

func (*ProjectsRulesetsDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsRulesetsGetCall) Do

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

Do executes the "firebaserules.projects.rulesets.get" call. Exactly one of *Ruleset or error will be non-nil. 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 information.

func (*ProjectsRulesetsGetCall) Header

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

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

func (*ProjectsRulesetsGetCall) IfNoneMatch

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

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 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsRulesetsListCall) Do

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

Do executes the "firebaserules.projects.rulesets.list" call. Exactly one of *ListRulesetsResponse or error will be non-nil. 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 information.

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-01") AND name=UUID-*`

func (*ProjectsRulesetsListCall) Header

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

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

func (*ProjectsRulesetsListCall) IfNoneMatch

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

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 (*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.

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.

func (*ProjectsRulesetsService) Get

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

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

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.

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/')
  }
}

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsTestCall) Do

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

Do executes the "firebaserules.projects.test" call. Exactly one of *TestRulesetResponse or error will be non-nil. 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 information.

func (*ProjectsTestCall) Header

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

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

type Release

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`.

type Release struct {
    // CreateTime: Time the release was created.
    // Output only.
    CreateTime string `json:"createTime,omitempty"`

    // Name: Resource name for the `Release`.
    //
    // `Release` names may be structured `app1/prod/v2` or flat
    // `app1_prod_v2`
    // which affords developers a great deal of flexibility in mapping the
    // name
    // to the style that best fits their existing development practices.
    // For
    // example, a name could refer to an environment, an app, a version, or
    // some
    // combination of three.
    //
    // In the table below, for the project name `projects/foo`, the
    // following
    // relative release paths show how flat and structured names might be
    // chosen
    // to match a desired development / deployment strategy.
    //
    // Use Case     | Flat Name           | Structured
    // Name
    // -------------|---------------------|----------------
    // Environments
    //  | releases/qa         | releases/qa
    // Apps         | releases/app1_qa    | releases/app1/qa
    // Versions     | releases/app1_v2_qa | releases/app1/v2/qa
    //
    // The delimiter between the release name path elements can be almost
    // anything
    // and it should work equally well with the release name list filter,
    // but in
    // many ways the structured paths provide a clearer picture of
    // the
    // relationship between `Release` instances.
    //
    // Format: `projects/{project_id}/releases/{release_id}`
    Name string `json:"name,omitempty"`

    // RulesetName: Name of the `Ruleset` referred to by this `Release`. The
    // `Ruleset` must
    // exist the `Release` to be created.
    RulesetName string `json:"rulesetName,omitempty"`

    // UpdateTime: Time the release was updated.
    // Output only.
    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 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. "CreateTime") 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:"-"`
}

func (*Release) MarshalJSON

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

type Result

Result: Possible result values from the function mock invocation.

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 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. "Undefined") 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:"-"`
}

func (*Result) MarshalJSON

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

type Ruleset

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

type Ruleset struct {
    // CreateTime: Time the `Ruleset` was created.
    // Output only.
    CreateTime string `json:"createTime,omitempty"`

    // Name: Name of the `Ruleset`. The ruleset_id is auto generated by the
    // service.
    // Format: `projects/{project_id}/rulesets/{ruleset_id}`
    // Output only.
    Name string `json:"name,omitempty"`

    // Source: `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. "CreateTime") 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. "CreateTime") 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:"-"`
}

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

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

type Source

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

type Source struct {
    // Files: `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 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. "Files") 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:"-"`
}

func (*Source) MarshalJSON

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

type SourcePosition

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.

type SourcePosition struct {
    // Column: First column on the source line associated with the source
    // fragment.
    Column int64 `json:"column,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 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. "Column") 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:"-"`
}

func (*SourcePosition) MarshalJSON

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

type TestCase

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.

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"`

    // 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"`

    // 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<string, string>`
    // headers        | `map<string, string>`
    // method         | `string`
    // params         | `map<string, string>`
    // 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 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. "Expectation") 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:"-"`
}

func (*TestCase) MarshalJSON

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

type TestResult

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

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"`

    // 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"`

    // ForceSendFields is a list of field names (e.g. "DebugMessages") 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. "DebugMessages") 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:"-"`
}

func (*TestResult) MarshalJSON

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

type TestRulesetRequest

TestRulesetRequest: The request for FirebaseRulesService.TestRuleset.

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: 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 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. "Source") 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:"-"`
}

func (*TestRulesetRequest) MarshalJSON

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

type TestRulesetResponse

TestRulesetResponse: The response for FirebaseRulesService.TestRuleset.

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 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. "Issues") 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:"-"`
}

func (*TestRulesetResponse) MarshalJSON

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

type TestSuite

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.

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 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. "TestCases") 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:"-"`
}

func (*TestSuite) MarshalJSON

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