Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.firebaseml/v1beta2.getModel
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets a model resource.
Using getModel
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getModel(args: GetModelArgs, opts?: InvokeOptions): Promise<GetModelResult>
function getModelOutput(args: GetModelOutputArgs, opts?: InvokeOptions): Output<GetModelResult>
def get_model(model_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetModelResult
def get_model_output(model_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetModelResult]
func LookupModel(ctx *Context, args *LookupModelArgs, opts ...InvokeOption) (*LookupModelResult, error)
func LookupModelOutput(ctx *Context, args *LookupModelOutputArgs, opts ...InvokeOption) LookupModelResultOutput
> Note: This function is named LookupModel
in the Go SDK.
public static class GetModel
{
public static Task<GetModelResult> InvokeAsync(GetModelArgs args, InvokeOptions? opts = null)
public static Output<GetModelResult> Invoke(GetModelInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetModelResult> getModel(GetModelArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:firebaseml/v1beta2:getModel
arguments:
# arguments dictionary
The following arguments are supported:
getModel Result
The following output properties are available:
- Active
Operations List<Pulumi.Google Native. Firebase ML. V1Beta2. Outputs. Operation Response> Lists operation ids associated with this model whose status is NOT done.
- Create
Time string Timestamp when this model was created in Firebase ML.
- Display
Name string 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.
- Etag string
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- Model
Hash string The model_hash will change if a new file is available for download.
- Name string
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.- State
Pulumi.
Google Native. Firebase ML. V1Beta2. Outputs. Model State Response State common to all model types. Includes publishing and validation information.
- List<string>
User defined tags which can be used to group/filter models during listing
- Tflite
Model Pulumi.Google Native. Firebase ML. V1Beta2. Outputs. Tf Lite Model Response A TFLite Model
- Update
Time string Timestamp when this model was updated in Firebase ML.
- Active
Operations []OperationResponse Lists operation ids associated with this model whose status is NOT done.
- Create
Time string Timestamp when this model was created in Firebase ML.
- Display
Name string 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.
- Etag string
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- Model
Hash string The model_hash will change if a new file is available for download.
- Name string
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.- State
Model
State Response State common to all model types. Includes publishing and validation information.
- []string
User defined tags which can be used to group/filter models during listing
- Tflite
Model TfLite Model Response A TFLite Model
- Update
Time string Timestamp when this model was updated in Firebase ML.
- active
Operations List<OperationResponse> Lists operation ids associated with this model whose status is NOT done.
- create
Time String Timestamp when this model was created in Firebase ML.
- display
Name String 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.
- etag String
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- model
Hash String The model_hash will change if a new file is available for download.
- name String
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.- state
Model
State Response State common to all model types. Includes publishing and validation information.
- List<String>
User defined tags which can be used to group/filter models during listing
- tflite
Model TfLite Model Response A TFLite Model
- update
Time String Timestamp when this model was updated in Firebase ML.
- active
Operations OperationResponse[] Lists operation ids associated with this model whose status is NOT done.
- create
Time string Timestamp when this model was created in Firebase ML.
- display
Name string 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.
- etag string
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- model
Hash string The model_hash will change if a new file is available for download.
- name string
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.- state
Model
State Response State common to all model types. Includes publishing and validation information.
- string[]
User defined tags which can be used to group/filter models during listing
- tflite
Model TfLite Model Response A TFLite Model
- update
Time string Timestamp when this model was updated in Firebase ML.
- active_
operations Sequence[OperationResponse] Lists operation ids associated with this model whose status is NOT done.
- create_
time str Timestamp when this model was created in Firebase ML.
- display_
name str 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.
- etag str
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- model_
hash str The model_hash will change if a new file is available for download.
- name str
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.- state
Model
State Response State common to all model types. Includes publishing and validation information.
- Sequence[str]
User defined tags which can be used to group/filter models during listing
- tflite_
model TfLite Model Response A TFLite Model
- update_
time str Timestamp when this model was updated in Firebase ML.
- active
Operations List<Property Map> Lists operation ids associated with this model whose status is NOT done.
- create
Time String Timestamp when this model was created in Firebase ML.
- display
Name String 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.
- etag String
See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3
- model
Hash String The model_hash will change if a new file is available for download.
- name String
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.- state Property Map
State common to all model types. Includes publishing and validation information.
- List<String>
User defined tags which can be used to group/filter models during listing
- tflite
Model Property Map A TFLite Model
- update
Time String Timestamp when this model was updated in Firebase ML.
Supporting Types
ModelStateResponse
- Published bool
Indicates if this model has been published.
- Validation
Error Pulumi.Google Native. Firebase ML. V1Beta2. Inputs. Status Response 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.
- Published bool
Indicates if this model has been published.
- Validation
Error StatusResponse 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.
- published Boolean
Indicates if this model has been published.
- validation
Error StatusResponse 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.
- published boolean
Indicates if this model has been published.
- validation
Error StatusResponse 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.
- published bool
Indicates if this model has been published.
- validation_
error StatusResponse 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.
- published Boolean
Indicates if this model has been published.
- validation
Error Property Map 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.
OperationResponse
- Done bool
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- Error
Pulumi.
Google Native. Firebase ML. V1Beta2. Inputs. Status Response The error result of the operation in case of failure or cancellation.
- Metadata Dictionary<string, string>
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.
- Name string
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 withoperations/{unique_id}
.- Response Dictionary<string, string>
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- Done bool
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- Error
Status
Response The error result of the operation in case of failure or cancellation.
- Metadata map[string]string
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.
- Name string
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 withoperations/{unique_id}
.- Response map[string]string
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done Boolean
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- error
Status
Response The error result of the operation in case of failure or cancellation.
- metadata Map<String,String>
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.
- name String
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 withoperations/{unique_id}
.- response Map<String,String>
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done boolean
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- error
Status
Response The error result of the operation in case of failure or cancellation.
- metadata {[key: string]: string}
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.
- name string
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 withoperations/{unique_id}
.- response {[key: string]: string}
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done bool
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- error
Status
Response The error result of the operation in case of failure or cancellation.
- metadata Mapping[str, str]
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.
- name str
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 withoperations/{unique_id}
.- response Mapping[str, str]
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
- done Boolean
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.- error Property Map
The error result of the operation in case of failure or cancellation.
- metadata Map<String>
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.
- name String
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 withoperations/{unique_id}
.- response Map<String>
The normal, successful response of the operation. If the original method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
StatusResponse
- Code int
The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
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.
- Code int
The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
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.
- code Integer
The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
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.
- code number
The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message string
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.
- code int
The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
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.
- code Number
The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
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.
TfLiteModelResponse
- Automl
Model string 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)
- Gcs
Tflite stringUri 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.
- Size
Bytes string The size of the TFLite model
- Automl
Model string 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)
- Gcs
Tflite stringUri 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.
- Size
Bytes string The size of the TFLite model
- automl
Model String 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)
- gcs
Tflite StringUri 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.
- size
Bytes String The size of the TFLite model
- automl
Model string 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)
- gcs
Tflite stringUri 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.
- size
Bytes string The size of the TFLite model
- automl_
model str 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)
- gcs_
tflite_ struri 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.
- size_
bytes str The size of the TFLite model
- automl
Model String 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)
- gcs
Tflite StringUri 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.
- size
Bytes String The size of the TFLite model
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.