Documentation

Overview

Package firebaseml provides access to the Firebase ML API.

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

Creating a client

Usage example:

import "google.golang.org/api/firebaseml/v1"
...
ctx := context.Background()
firebasemlService, err := firebaseml.NewService(ctx)

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

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

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

firebasemlService, err := firebaseml.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

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

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

    OAuth2 scopes used by this API.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type CancelOperationRequest

    type CancelOperationRequest struct {
    }

      CancelOperationRequest: The request message for Operations.CancelOperation.

      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 ListOperationsResponse

        type ListOperationsResponse struct {
        	// NextPageToken: The standard List next-page token.
        	NextPageToken string `json:"nextPageToken,omitempty"`
        
        	// Operations: A list of operations that matches the specified filter in
        	// the request.
        	Operations []*Operation `json:"operations,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:"-"`
        }

          ListOperationsResponse: The response message for Operations.ListOperations.

          func (*ListOperationsResponse) MarshalJSON

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

          type ModelOperationMetadata

          type ModelOperationMetadata struct {
          	// Possible values:
          	//   "BASIC_OPERATION_STATUS_UNSPECIFIED" - The status is unspecified
          	//   "BASIC_OPERATION_STATUS_UPLOADING" - The model file is being
          	// uploaded
          	//   "BASIC_OPERATION_STATUS_VERIFYING" - The model file is being
          	// verified
          	BasicOperationStatus string `json:"basicOperationStatus,omitempty"`
          
          	// Name: The name of the model we are creating/updating
          	// The name must have the form `projects/{project_id}/models/{model_id}`
          	Name string `json:"name,omitempty"`
          
          	// ForceSendFields is a list of field names (e.g.
          	// "BasicOperationStatus") 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. "BasicOperationStatus") 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:"-"`
          }

            ModelOperationMetadata: This is returned in the longrunning operations for create/update.

            func (*ModelOperationMetadata) MarshalJSON

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

            type Operation

            type Operation struct {
            	// Done: If the value is `false`, it means the operation is still in
            	// progress.
            	// If `true`, the operation is completed, and either `error` or
            	// `response` is
            	// available.
            	Done bool `json:"done,omitempty"`
            
            	// Error: The error result of the operation in case of failure or
            	// cancellation.
            	Error *Status `json:"error,omitempty"`
            
            	// Metadata: Service-specific metadata associated with the operation.
            	// It typically
            	// contains progress information and common metadata such as create
            	// time.
            	// Some services might not provide such metadata.  Any method that
            	// returns a
            	// long-running operation should document the metadata type, if any.
            	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
            
            	// Name: The server-assigned name, which is only unique within the same
            	// service that
            	// originally returns it. If you use the default HTTP mapping,
            	// the
            	// `name` should be a resource name ending with
            	// `operations/{unique_id}`.
            	Name string `json:"name,omitempty"`
            
            	// Response: The normal response of the operation in case of success.
            	// If the original
            	// method returns no data on success, such as `Delete`, the response
            	// is
            	// `google.protobuf.Empty`.  If the original method is
            	// standard
            	// `Get`/`Create`/`Update`, the response should be the resource.  For
            	// other
            	// methods, the response should have the type `XxxResponse`, where
            	// `Xxx`
            	// is the original method name.  For example, if the original method
            	// name
            	// is `TakeSnapshot()`, the inferred response type
            	// is
            	// `TakeSnapshotResponse`.
            	Response googleapi.RawMessage `json:"response,omitempty"`
            
            	// ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"`
            }

              Operation: This resource represents a long-running operation that is the result of a network API call.

              func (*Operation) MarshalJSON

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

              type OperationsCancelCall

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

              func (*OperationsCancelCall) Context

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

                func (*OperationsCancelCall) Do

                  Do executes the "firebaseml.operations.cancel" 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 (*OperationsCancelCall) Fields

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

                    func (*OperationsCancelCall) Header

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

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

                      type OperationsDeleteCall

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

                      func (*OperationsDeleteCall) Context

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

                        func (*OperationsDeleteCall) Do

                          Do executes the "firebaseml.operations.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 (*OperationsDeleteCall) Fields

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

                            func (*OperationsDeleteCall) Header

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

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

                              type OperationsListCall

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

                              func (*OperationsListCall) Context

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

                                func (*OperationsListCall) Do

                                  Do executes the "firebaseml.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*OperationsListCall) Fields

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

                                    func (*OperationsListCall) Filter

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

                                      Filter sets the optional parameter "filter": The standard list filter.

                                      func (*OperationsListCall) Header

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

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

                                        func (*OperationsListCall) IfNoneMatch

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

                                          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 (*OperationsListCall) PageSize

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

                                            PageSize sets the optional parameter "pageSize": The standard list page size.

                                            func (*OperationsListCall) PageToken

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

                                              PageToken sets the optional parameter "pageToken": The standard list page token.

                                              func (*OperationsListCall) Pages

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

                                                type OperationsService

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

                                                func NewOperationsService

                                                func NewOperationsService(s *Service) *OperationsService

                                                func (*OperationsService) Cancel

                                                func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

                                                  Cancel: Starts asynchronous cancellation on a long-running operation.

                                                  The server
                                                  

                                                  makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

                                                  func (*OperationsService) Delete

                                                    Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

                                                    func (*OperationsService) List

                                                      List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

                                                      NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

                                                      type Service

                                                      type Service struct {
                                                      	BasePath  string // API endpoint base URL
                                                      	UserAgent string // optional additional User-Agent fragment
                                                      
                                                      	Operations *OperationsService
                                                      	// contains filtered or unexported fields
                                                      }

                                                      func New

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

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

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

                                                        func NewService

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

                                                          NewService creates a new Service.

                                                          type Status

                                                          type Status struct {
                                                          	// Code: The status code, which should be an enum value of
                                                          	// google.rpc.Code.
                                                          	Code int64 `json:"code,omitempty"`
                                                          
                                                          	// Details: A list of messages that carry the error details.  There is a
                                                          	// common set of
                                                          	// message types for APIs to use.
                                                          	Details []googleapi.RawMessage `json:"details,omitempty"`
                                                          
                                                          	// Message: A developer-facing error message, which should be in
                                                          	// English. Any
                                                          	// user-facing error message should be localized and sent in
                                                          	// the
                                                          	// google.rpc.Status.details field, or localized by the client.
                                                          	Message string `json:"message,omitempty"`
                                                          
                                                          	// ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
                                                          }

                                                            Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.

                                                            You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

                                                            func (*Status) MarshalJSON

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