firebaserules

package
v0.0.0-...-adeea6a Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2022 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package firebaserules provides access to the Firebase Rules API.

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

Usage example: 

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

Index

Constants

View Source 
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

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

}

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

type File 

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

File: `File` containing source content.

func (*File) MarshalJSON 

func (s *File) 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 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:"-"`
}

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

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

ListRulesetsResponse: The response for FirebaseRulesService.ListRulesets

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.

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.

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) 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` and also on the `Ruleset` `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/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 for release and ruleset names are relative to the project releases and rulesets collections. Fully qualified prefixed may also be used. e.g. `name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`

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 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 (*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, and the custom `Release` name may be referenced by specifying the `X-Firebase-Rules-Release-Name` header.

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 or `Ruleset` id or both.

func (*ProjectsReleasesService) Update 

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

Update: Update a `Release`.

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

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.

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.

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.

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) 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) 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 in the rules, if any, will be returned to the caller with a description, severity, and source location.

The test method will typically be executed with a developer provided `Source`, but if regression testing is desired, this method may be executed against a `Ruleset` resource name and the `Source` will be retrieved from the persisted `Ruleset`.

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.userId
          && (imageName.endsWith('.png') ||

imageName.endsWith('.jpg')) 

          && resource.mimeType.startsWith('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.

type Release 

type Release struct {
	// CreateTime: Time the release was created.
	// @OutputOnly
	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.
	// @OutputOnly
	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:"-"`
}

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 Ruleset 

type Ruleset struct {
	// CreateTime: Time the `Ruleset` was created.
	// @OutputOnly
	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}`
	// @OutputOnly
	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:"-"`
}

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 

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

type Source 

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

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

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

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 TestRulesetRequest 

type TestRulesetRequest struct {
	// Source: `Source` to be checked for correctness.
	Source *Source `json:"source,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:"-"`
}

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

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

TestRulesetResponse: The response for FirebaseRulesService.TestRuleset.

func (*TestRulesetResponse) MarshalJSON 

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