OAuth2 scopes used by this API.
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"
)
DownloadModelResponse: The response for downloading a model to device.
type DownloadModelResponse struct {
// DownloadUri: Output only. A download URI for the model/zip file.
DownloadUri string `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.
ExpireTime string `json:"expireTime,omitempty"`
// ModelFormat: Output only. The format of the model being downloaded.
//
// Possible values:
// "MODEL_FORMAT_UNSPECIFIED" - Unknown format
// "TFLITE" - TFLite model
ModelFormat string `json:"modelFormat,omitempty"`
// SizeBytes: Output only. The size of the file(s), if this information is
// available.
SizeBytes int64 `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:"-"`
}
func (s *DownloadModelResponse) MarshalJSON() ([]byte, error)
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
ListModelsResponse: The response for list models
type ListModelsResponse struct {
// Models: The list of models
Models []*Model `json:"models,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `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:"-"`
}
func (s *ListModelsResponse) MarshalJSON() ([]byte, error)
Model: An ML model hosted in Firebase ML
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.
CreateTime string `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.
DisplayName string `json:"displayName,omitempty"`
// Etag: Output only. See RFC7232
// https://tools.ietf.org/html/rfc7232#section-2.3
Etag string `json:"etag,omitempty"`
// ModelHash: Output only. The model_hash will change if a new file is
// available for download.
ModelHash string `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.
Name string `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
// listing
Tags []string `json:"tags,omitempty"`
// TfliteModel: A TFLite Model
TfliteModel *TfLiteModel `json:"tfliteModel,omitempty"`
// UpdateTime: Output only. Timestamp when this model was updated in Firebase
// ML.
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. "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:"-"`
}
func (s *Model) MarshalJSON() ([]byte, error)
ModelOperationMetadata: This is returned in the longrunning operations for create/update.
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 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:"-"`
}
func (s *ModelOperationMetadata) MarshalJSON() ([]byte, error)
ModelState: State common to all model types. Includes publishing and validation information.
type ModelState struct {
// Published: Indicates if this model has been published.
Published bool `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:"-"`
}
func (s *ModelState) MarshalJSON() ([]byte, error)
Operation: This resource represents a long-running operation that is the result of a network API call.
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, 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`.
Response googleapi.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:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
type ProjectsModelsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsCreateCall) Context(ctx context.Context) *ProjectsModelsCreateCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsCreateCall) Fields(s ...googleapi.Field) *ProjectsModelsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsModelsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsDeleteCall) Context(ctx context.Context) *ProjectsModelsDeleteCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsDeleteCall) Fields(s ...googleapi.Field) *ProjectsModelsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsModelsDownloadCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsDownloadCall) Context(ctx context.Context) *ProjectsModelsDownloadCall
Context sets the context to be used in this call's Do method.
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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsDownloadCall) Fields(s ...googleapi.Field) *ProjectsModelsDownloadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsDownloadCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsModelsDownloadCall) IfNoneMatch(entityTag string) *ProjectsModelsDownloadCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsModelsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsGetCall) Context(ctx context.Context) *ProjectsModelsGetCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsGetCall) Fields(s ...googleapi.Field) *ProjectsModelsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsModelsGetCall) IfNoneMatch(entityTag string) *ProjectsModelsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsModelsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsListCall) Context(ctx context.Context) *ProjectsModelsListCall
Context sets the context to be used in this call's Do method.
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsListCall) Fields(s ...googleapi.Field) *ProjectsModelsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsListCall) Filter(filter string) *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 (c *ProjectsModelsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsModelsListCall) IfNoneMatch(entityTag string) *ProjectsModelsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsModelsListCall) PageSize(pageSize int64) *ProjectsModelsListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return
func (c *ProjectsModelsListCall) PageToken(pageToken string) *ProjectsModelsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *ProjectsModelsListCall) Pages(ctx context.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.
type ProjectsModelsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsModelsPatchCall) Context(ctx context.Context) *ProjectsModelsPatchCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsModelsPatchCall) Fields(s ...googleapi.Field) *ProjectsModelsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsModelsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsModelsPatchCall) UpdateMask(updateMask string) *ProjectsModelsPatchCall
UpdateMask sets the optional parameter "updateMask": The update mask
type ProjectsModelsService struct {
// contains filtered or unexported fields
}
func NewProjectsModelsService(s *Service) *ProjectsModelsService
func (r *ProjectsModelsService) Create(parent string, model *Model) *ProjectsModelsCreateCall
Create: Creates a model in Firebase ML. The longrunning operation will eventually return a Model
func (r *ProjectsModelsService) Delete(name string) *ProjectsModelsDeleteCall
Delete: Deletes a model
func (r *ProjectsModelsService) Download(name string) *ProjectsModelsDownloadCall
Download: Gets Download information for a model. This is meant for downloading model resources onto devices. It gives very limited information about the model.
func (r *ProjectsModelsService) Get(name string) *ProjectsModelsGetCall
Get: Gets a model resource.
func (r *ProjectsModelsService) List(parent string) *ProjectsModelsListCall
List: Lists the models
func (r *ProjectsModelsService) Patch(name string, model *Model) *ProjectsModelsPatchCall
Patch: Updates a model. The longrunning operation will eventually return a Model.
type ProjectsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
type ProjectsService struct {
Models *ProjectsModelsService
Operations *ProjectsOperationsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
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).
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 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:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
TfLiteModel: Information that is specific to TfLite models.
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)
AutomlModel string `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.
GcsTfliteUri string `json:"gcsTfliteUri,omitempty"`
// SizeBytes: Output only. The size of the TFLite model
SizeBytes string `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:"-"`
}
func (s *TfLiteModel) MarshalJSON() ([]byte, error)