firebaseml
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package firebaseml provides access to the Firebase ML API.
For product documentation, see:https://firebase.google.com
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/firebaseml/v1beta2"...ctx := context.Background()firebasemlService, err := firebaseml.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)firebasemlService, err := firebaseml.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type DownloadModelResponse
- type Empty
- type ListModelsResponse
- type Model
- type ModelOperationMetadata
- type ModelState
- type Operation
- type ProjectsModelsCreateCall
- func (c *ProjectsModelsCreateCall) Context(ctx context.Context) *ProjectsModelsCreateCall
- func (c *ProjectsModelsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsModelsCreateCall) Fields(s ...googleapi.Field) *ProjectsModelsCreateCall
- func (c *ProjectsModelsCreateCall) Header() http.Header
- type ProjectsModelsDeleteCall
- func (c *ProjectsModelsDeleteCall) Context(ctx context.Context) *ProjectsModelsDeleteCall
- func (c *ProjectsModelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsModelsDeleteCall) Fields(s ...googleapi.Field) *ProjectsModelsDeleteCall
- func (c *ProjectsModelsDeleteCall) Header() http.Header
- type ProjectsModelsDownloadCall
- func (c *ProjectsModelsDownloadCall) Context(ctx context.Context) *ProjectsModelsDownloadCall
- func (c *ProjectsModelsDownloadCall) Do(opts ...googleapi.CallOption) (*DownloadModelResponse, error)
- func (c *ProjectsModelsDownloadCall) Fields(s ...googleapi.Field) *ProjectsModelsDownloadCall
- func (c *ProjectsModelsDownloadCall) Header() http.Header
- func (c *ProjectsModelsDownloadCall) IfNoneMatch(entityTag string) *ProjectsModelsDownloadCall
- type ProjectsModelsGetCall
- func (c *ProjectsModelsGetCall) Context(ctx context.Context) *ProjectsModelsGetCall
- func (c *ProjectsModelsGetCall) Do(opts ...googleapi.CallOption) (*Model, error)
- func (c *ProjectsModelsGetCall) Fields(s ...googleapi.Field) *ProjectsModelsGetCall
- func (c *ProjectsModelsGetCall) Header() http.Header
- func (c *ProjectsModelsGetCall) IfNoneMatch(entityTag string) *ProjectsModelsGetCall
- type ProjectsModelsListCall
- func (c *ProjectsModelsListCall) Context(ctx context.Context) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) Do(opts ...googleapi.CallOption) (*ListModelsResponse, error)
- func (c *ProjectsModelsListCall) Fields(s ...googleapi.Field) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) Filter(filter string) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) Header() http.Header
- func (c *ProjectsModelsListCall) IfNoneMatch(entityTag string) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) PageSize(pageSize int64) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) PageToken(pageToken string) *ProjectsModelsListCall
- func (c *ProjectsModelsListCall) Pages(ctx context.Context, f func(*ListModelsResponse) error) error
- type ProjectsModelsPatchCall
- func (c *ProjectsModelsPatchCall) Context(ctx context.Context) *ProjectsModelsPatchCall
- func (c *ProjectsModelsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsModelsPatchCall) Fields(s ...googleapi.Field) *ProjectsModelsPatchCall
- func (c *ProjectsModelsPatchCall) Header() http.Header
- func (c *ProjectsModelsPatchCall) UpdateMask(updateMask string) *ProjectsModelsPatchCall
- type ProjectsModelsService
- func (r *ProjectsModelsService) Create(parent string, model *Model) *ProjectsModelsCreateCall
- func (r *ProjectsModelsService) Delete(name string) *ProjectsModelsDeleteCall
- func (r *ProjectsModelsService) Download(name string) *ProjectsModelsDownloadCall
- func (r *ProjectsModelsService) Get(name string) *ProjectsModelsGetCall
- func (r *ProjectsModelsService) List(parent string) *ProjectsModelsListCall
- func (r *ProjectsModelsService) Patch(name string, model *Model) *ProjectsModelsPatchCall
- type ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Header() http.Header
- func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
- type ProjectsOperationsService
- type ProjectsService
- type Service
- type Status
- type TfLiteModel
Constants¶
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeDownloadModelResponse¶added inv0.40.0
type DownloadModelResponse struct {// DownloadUri: Output only. A download URI for the model/zip file.DownloadUristring `json:"downloadUri,omitempty"`// ExpireTime: Output only. The time that the download URI link expires. If the// link has expired, the REST call must be repeated.ExpireTimestring `json:"expireTime,omitempty"`// ModelFormat: Output only. The format of the model being downloaded.//// Possible values:// "MODEL_FORMAT_UNSPECIFIED" - Unknown format// "TFLITE" - TFLite modelModelFormatstring `json:"modelFormat,omitempty"`// SizeBytes: Output only. The size of the file(s), if this information is// available.SizeBytesint64 `json:"sizeBytes,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DownloadUri") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DownloadUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DownloadModelResponse: The response for downloading a model to device.
func (DownloadModelResponse)MarshalJSON¶added inv0.40.0
func (sDownloadModelResponse) MarshalJSON() ([]byte,error)
typeEmpty¶
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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
typeListModelsResponse¶
type ListModelsResponse struct {// Models: The list of modelsModels []*Model `json:"models,omitempty"`// NextPageToken: Token to retrieve the next page of results, or empty if there// are no more results in the list.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Models") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Models") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListModelsResponse: The response for list models
func (ListModelsResponse)MarshalJSON¶
func (sListModelsResponse) MarshalJSON() ([]byte,error)
typeModel¶
type Model struct {// ActiveOperations: Output only. Lists operation ids associated with this// model whose status is NOT done.ActiveOperations []*Operation `json:"activeOperations,omitempty"`// CreateTime: Output only. Timestamp when this model was created in Firebase// ML.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Required. The name of the model to create. The name can be up// to 32 characters long and can consist only of ASCII Latin letters A-Z and// a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.DisplayNamestring `json:"displayName,omitempty"`// Etag: Output only. See RFC7232//https://tools.ietf.org/html/rfc7232#section-2.3Etagstring `json:"etag,omitempty"`// ModelHash: Output only. The model_hash will change if a new file is// available for download.ModelHashstring `json:"modelHash,omitempty"`// Name: The resource name of the Model. Model names have the form// `projects/{project_id}/models/{model_id}` The name is ignored when creating// a model.Namestring `json:"name,omitempty"`// State: State common to all model types. Includes publishing and validation// information.State *ModelState `json:"state,omitempty"`// Tags: User defined tags which can be used to group/filter models during// listingTags []string `json:"tags,omitempty"`// TfliteModel: A TFLite ModelTfliteModel *TfLiteModel `json:"tfliteModel,omitempty"`// UpdateTime: Output only. Timestamp when this model was updated in Firebase// ML.UpdateTimestring `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. "ActiveOperations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveOperations") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Model: An ML model hosted in Firebase ML
func (Model)MarshalJSON¶
typeModelOperationMetadata¶
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 verifiedBasicOperationStatusstring `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}`Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "BasicOperationStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BasicOperationStatus") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ModelOperationMetadata: This is returned in the longrunning operations forcreate/update.
func (ModelOperationMetadata)MarshalJSON¶
func (sModelOperationMetadata) MarshalJSON() ([]byte,error)
typeModelState¶
type ModelState struct {// Published: Indicates if this model has been published.Publishedbool `json:"published,omitempty"`// ValidationError: Output only. Indicates the latest validation error on the// model if any. A model may have validation errors if there were problems// during the model creation/update. e.g. in the case of a TfLiteModel, if a// tflite model file was missing or in the wrong format. This field will be// empty for valid models.ValidationError *Status `json:"validationError,omitempty"`// ForceSendFields is a list of field names (e.g. "Published") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Published") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ModelState: State common to all model types. Includes publishing andvalidation information.
func (ModelState)MarshalJSON¶
func (sModelState) MarshalJSON() ([]byte,error)
typeOperation¶
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.Donebool `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.Metadatagoogleapi.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}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. 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`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Operation: This resource represents a long-running operation that is theresult of a network API call.
func (Operation)MarshalJSON¶
typeProjectsModelsCreateCall¶
type ProjectsModelsCreateCall struct {// contains filtered or unexported fields}func (*ProjectsModelsCreateCall)Context¶
func (c *ProjectsModelsCreateCall) Context(ctxcontext.Context) *ProjectsModelsCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsCreateCall)Do¶
func (c *ProjectsModelsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "firebaseml.projects.models.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsModelsCreateCall)Fields¶
func (c *ProjectsModelsCreateCall) Fields(s ...googleapi.Field) *ProjectsModelsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsCreateCall)Header¶
func (c *ProjectsModelsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsModelsDeleteCall¶
type ProjectsModelsDeleteCall struct {// contains filtered or unexported fields}func (*ProjectsModelsDeleteCall)Context¶
func (c *ProjectsModelsDeleteCall) Context(ctxcontext.Context) *ProjectsModelsDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsDeleteCall)Do¶
func (c *ProjectsModelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "firebaseml.projects.models.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsModelsDeleteCall)Fields¶
func (c *ProjectsModelsDeleteCall) Fields(s ...googleapi.Field) *ProjectsModelsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsDeleteCall)Header¶
func (c *ProjectsModelsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsModelsDownloadCall¶added inv0.40.0
type ProjectsModelsDownloadCall struct {// contains filtered or unexported fields}func (*ProjectsModelsDownloadCall)Context¶added inv0.40.0
func (c *ProjectsModelsDownloadCall) Context(ctxcontext.Context) *ProjectsModelsDownloadCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsDownloadCall)Do¶added inv0.40.0
func (c *ProjectsModelsDownloadCall) Do(opts ...googleapi.CallOption) (*DownloadModelResponse,error)
Do executes the "firebaseml.projects.models.download" call.Any non-2xx status code is an error. Response headers are in either*DownloadModelResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsModelsDownloadCall)Fields¶added inv0.40.0
func (c *ProjectsModelsDownloadCall) Fields(s ...googleapi.Field) *ProjectsModelsDownloadCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsDownloadCall)Header¶added inv0.40.0
func (c *ProjectsModelsDownloadCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsModelsDownloadCall)IfNoneMatch¶added inv0.40.0
func (c *ProjectsModelsDownloadCall) IfNoneMatch(entityTagstring) *ProjectsModelsDownloadCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsModelsGetCall¶
type ProjectsModelsGetCall struct {// contains filtered or unexported fields}func (*ProjectsModelsGetCall)Context¶
func (c *ProjectsModelsGetCall) Context(ctxcontext.Context) *ProjectsModelsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsGetCall)Do¶
func (c *ProjectsModelsGetCall) Do(opts ...googleapi.CallOption) (*Model,error)
Do executes the "firebaseml.projects.models.get" call.Any non-2xx status code is an error. Response headers are in either*Model.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsModelsGetCall)Fields¶
func (c *ProjectsModelsGetCall) Fields(s ...googleapi.Field) *ProjectsModelsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsGetCall)Header¶
func (c *ProjectsModelsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsModelsGetCall)IfNoneMatch¶
func (c *ProjectsModelsGetCall) IfNoneMatch(entityTagstring) *ProjectsModelsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsModelsListCall¶
type ProjectsModelsListCall struct {// contains filtered or unexported fields}func (*ProjectsModelsListCall)Context¶
func (c *ProjectsModelsListCall) Context(ctxcontext.Context) *ProjectsModelsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsListCall)Do¶
func (c *ProjectsModelsListCall) Do(opts ...googleapi.CallOption) (*ListModelsResponse,error)
Do executes the "firebaseml.projects.models.list" call.Any non-2xx status code is an error. Response headers are in either*ListModelsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsModelsListCall)Fields¶
func (c *ProjectsModelsListCall) Fields(s ...googleapi.Field) *ProjectsModelsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsListCall)Filter¶
func (c *ProjectsModelsListCall) Filter(filterstring) *ProjectsModelsListCall
Filter sets the optional parameter "filter": A filter for the list e.g.'tags: abc' to list models which are tagged with "abc"
func (*ProjectsModelsListCall)Header¶
func (c *ProjectsModelsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsModelsListCall)IfNoneMatch¶
func (c *ProjectsModelsListCall) IfNoneMatch(entityTagstring) *ProjectsModelsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsModelsListCall)PageSize¶
func (c *ProjectsModelsListCall) PageSize(pageSizeint64) *ProjectsModelsListCall
PageSize sets the optional parameter "pageSize": The maximum number of itemsto return
func (*ProjectsModelsListCall)PageToken¶
func (c *ProjectsModelsListCall) PageToken(pageTokenstring) *ProjectsModelsListCall
PageToken sets the optional parameter "pageToken": The next_page_token valuereturned from a previous List request, if any.
func (*ProjectsModelsListCall)Pages¶
func (c *ProjectsModelsListCall) Pages(ctxcontext.Context, f func(*ListModelsResponse)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.
typeProjectsModelsPatchCall¶
type ProjectsModelsPatchCall struct {// contains filtered or unexported fields}func (*ProjectsModelsPatchCall)Context¶
func (c *ProjectsModelsPatchCall) Context(ctxcontext.Context) *ProjectsModelsPatchCall
Context sets the context to be used in this call's Do method.
func (*ProjectsModelsPatchCall)Do¶
func (c *ProjectsModelsPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "firebaseml.projects.models.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsModelsPatchCall)Fields¶
func (c *ProjectsModelsPatchCall) Fields(s ...googleapi.Field) *ProjectsModelsPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsModelsPatchCall)Header¶
func (c *ProjectsModelsPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsModelsPatchCall)UpdateMask¶
func (c *ProjectsModelsPatchCall) UpdateMask(updateMaskstring) *ProjectsModelsPatchCall
UpdateMask sets the optional parameter "updateMask": The update mask
typeProjectsModelsService¶
type ProjectsModelsService struct {// contains filtered or unexported fields}funcNewProjectsModelsService¶
func NewProjectsModelsService(s *Service) *ProjectsModelsService
func (*ProjectsModelsService)Create¶
func (r *ProjectsModelsService) Create(parentstring, model *Model) *ProjectsModelsCreateCall
Create: Creates a model in Firebase ML. The longrunning operation willeventually return a Model
- parent: The parent project resource where the model is to be created. Theparent must have the form `projects/{project_id}`.
func (*ProjectsModelsService)Delete¶
func (r *ProjectsModelsService) Delete(namestring) *ProjectsModelsDeleteCall
Delete: Deletes a model
- name: The name of the model to delete. The name must have the form`projects/{project_id}/models/{model_id}`.
func (*ProjectsModelsService)Download¶added inv0.40.0
func (r *ProjectsModelsService) Download(namestring) *ProjectsModelsDownloadCall
Download: Gets Download information for a model. This is meant fordownloading model resources onto devices. It gives very limited informationabout the model.
- name: The name of the model to download. The name must have the form`projects/{project}/models/{model}`.
func (*ProjectsModelsService)Get¶
func (r *ProjectsModelsService) Get(namestring) *ProjectsModelsGetCall
Get: Gets a model resource.
- name: The name of the model to get. The name must have the form`projects/{project_id}/models/{model_id}`.
func (*ProjectsModelsService)List¶
func (r *ProjectsModelsService) List(parentstring) *ProjectsModelsListCall
List: Lists the models
- parent: The name of the parent to list models for. The parent must havethe form `projects/{project_id}'.
func (*ProjectsModelsService)Patch¶
func (r *ProjectsModelsService) Patch(namestring, model *Model) *ProjectsModelsPatchCall
Patch: Updates a model. The longrunning operation will eventually return aModel.
- name: The resource name of the Model. Model names have the form`projects/{project_id}/models/{model_id}` The name is ignored whencreating a model.
typeProjectsOperationsGetCall¶
type ProjectsOperationsGetCall struct {// contains filtered or unexported fields}func (*ProjectsOperationsGetCall)Context¶
func (c *ProjectsOperationsGetCall) Context(ctxcontext.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsOperationsGetCall)Do¶
func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "firebaseml.projects.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsOperationsGetCall)Fields¶
func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsOperationsGetCall)Header¶
func (c *ProjectsOperationsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsOperationsGetCall)IfNoneMatch¶
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTagstring) *ProjectsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsOperationsService¶
type ProjectsOperationsService struct {// contains filtered or unexported fields}funcNewProjectsOperationsService¶
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
func (*ProjectsOperationsService)Get¶
func (r *ProjectsOperationsService) Get(namestring) *ProjectsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.
- name: The name of the operation resource.
typeProjectsService¶
type ProjectsService struct {Models *ProjectsModelsServiceOperations *ProjectsOperationsService// contains filtered or unexported fields}funcNewProjectsService¶
func NewProjectsService(s *Service) *ProjectsService
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶
NewService creates a new Service.
typeStatus¶
type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).
func (Status)MarshalJSON¶
typeTfLiteModel¶
type TfLiteModel struct {// AutomlModel: The AutoML model id referencing a model you created with the// AutoML API. The name should have format 'projects//locations//models/' (This// is the model resource name returned from the AutoML API)AutomlModelstring `json:"automlModel,omitempty"`// GcsTfliteUri: The TfLite file containing the model. (Stored in Google// Cloud). The gcs_tflite_uri should have form:// gs://some-bucket/some-model.tflite Note: If you update the file in the// original location, it is necessary to call UpdateModel for ML to pick up and// validate the updated file.GcsTfliteUristring `json:"gcsTfliteUri,omitempty"`// SizeBytes: Output only. The size of the TFLite modelSizeBytesstring `json:"sizeBytes,omitempty"`// ForceSendFields is a list of field names (e.g. "AutomlModel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutomlModel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TfLiteModel: Information that is specific to TfLite models.
func (TfLiteModel)MarshalJSON¶
func (sTfLiteModel) MarshalJSON() ([]byte,error)
Source Files